api

package
v1.0.10 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// Region https://www.volcengine.com/docs/6369/67268
	Region = "cn-beijing"

	// Algorithm https://www.volcengine.com/docs/6369/67270
	Algorithm = "HMAC-SHA256"
)

Variables

This section is empty.

Functions

func Exec

func Exec[T any](r *resty.Request, method, addr, path, action, version, region, service string, args ...any) (t T, _ error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(account config.Account) *Client

func (*Client) GetArkUsage added in v1.0.7

func (c *Client) GetArkUsage(req *GetArkUsageReq) ([]*GetArkUsageResult, error)

func (*Client) ListArkEndpoints added in v1.0.7

func (c *Client) ListArkEndpoints(req *ListArkEndpointsReq) ([]*ListArkEndpointsItem, error)

func (*Client) ListBillDetail added in v1.0.6

func (c *Client) ListBillDetail(req *ListBillDetailReq) ([]*ListBillDetailItem, error)

func (*Client) QueryBalanceAcct

func (c *Client) QueryBalanceAcct() (*QueryBalanceAcctData, error)

func (*Client) R

func (c *Client) R() *resty.Request

type GetArkUsageData added in v1.0.7

type GetArkUsageData struct {
	UsageResults []*GetArkUsageResult `json:"UsageResults"`
}

type GetArkUsageMetricItem added in v1.0.7

type GetArkUsageMetricItem struct {
	Values []*GetArkUsageMetricValue `json:"Values"`
}

type GetArkUsageMetricValue added in v1.0.7

type GetArkUsageMetricValue struct {
	Timestamp int `json:"Timestamp"`
	Value     int `json:"Value"`
}

type GetArkUsageReq added in v1.0.7

type GetArkUsageReq struct {
	StartTime   int      `json:"StartTime"`
	EndTime     int      `json:"EndTime"`
	Interval    int      `json:"Interval"`
	EndpointIds []string `json:"EndpointIds,omitempty"`
}

type GetArkUsageResult added in v1.0.7

type GetArkUsageResult struct {
	Name        string                   `json:"Name"`
	MetricItems []*GetArkUsageMetricItem `json:"MetricItems"`
}

type ListArkEndpointsData added in v1.0.7

type ListArkEndpointsData struct {
	PageNumber int `json:"PageNumber"`
	PageSize   int `json:"PageSize"`
	TotalCount int `json:"TotalCount"`

	Items []*ListArkEndpointsItem `json:"Items"`
}

type ListArkEndpointsItem added in v1.0.7

type ListArkEndpointsItem struct {
	Id          string `json:"Id"`
	Name        string `json:"Name"`
	Description string `json:"Description"`
	ProjectName string `json:"ProjectName"`
	Status      string `json:"Status"`
}

type ListArkEndpointsReq added in v1.0.7

type ListArkEndpointsReq struct {
	PageNumber int `json:"PageNumber"`
	PageSize   int `json:"PageSize"`
}

type ListBillDetailData added in v1.0.6

type ListBillDetailData struct {
	Offset int `json:"Offset"`
	Limit  int `json:"Limit"`
	Total  int `json:"Total"`

	List []*ListBillDetailItem `json:"List"`
}

type ListBillDetailItem added in v1.0.6

type ListBillDetailItem struct {
	ExpenseDate   string `json:"ExpenseDate"`
	Product       string `json:"Product"`
	ProductZh     string `json:"ProductZh"`
	PayableAmount string `json:"PayableAmount"`
}

type ListBillDetailReq added in v1.0.6

type ListBillDetailReq struct {
	Offset        int    `json:"Offset"`
	Limit         int    `json:"Limit"`
	BillPeriod    string `json:"BillPeriod"`
	ExpenseDate   string `json:"ExpenseDate"`
	GroupPeriod   int    `json:"GroupPeriod"`
	GroupTerm     int    `json:"GroupTerm"`
	IgnoreZero    int    `json:"IgnoreZero"`
	NeedRecordNum int    `json:"NeedRecordNum"`
}

type QueryBalanceAcctData

type QueryBalanceAcctData struct {
	AccountID        int    `json:"AccountID"`
	ArrearsBalance   string `json:"ArrearsBalance"`
	AvailableBalance string `json:"AvailableBalance"`
	CashBalance      string `json:"CashBalance"`
	CreditLimit      string `json:"CreditLimit"`
	FreezeAmount     string `json:"FreezeAmount"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL