arms

Documentation

Index

• type ARMSQueryDataSetDimensions
• type ARMSQueryDataSetOptionalDims
• type ARMSQueryDataSetRequest
  • func CreateARMSQueryDataSetRequest() (request *ARMSQueryDataSetRequest)
• type ARMSQueryDataSetRequiredDims
• type ARMSQueryDataSetResponse
  • func CreateARMSQueryDataSetResponse() (response *ARMSQueryDataSetResponse)
• type Client
  • func NewClient() (client *Client, err error)
  • func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)
  • func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)
  • func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)
  • func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)
  • func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)
  • func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)
  • func (client *Client) ARMSQueryDataSet(request *ARMSQueryDataSetRequest) (response *ARMSQueryDataSetResponse, err error)
  • func (client *Client) ARMSQueryDataSetWithCallback(request *ARMSQueryDataSetRequest, ...) <-chan int
  • func (client *Client) ARMSQueryDataSetWithChan(request *ARMSQueryDataSetRequest) (<-chan *ARMSQueryDataSetResponse, <-chan error)
  • func (client *Client) WhereInDimQuery(request *WhereInDimQueryRequest) (response *WhereInDimQueryResponse, err error)
  • func (client *Client) WhereInDimQueryWithCallback(request *WhereInDimQueryRequest, ...) <-chan int
  • func (client *Client) WhereInDimQueryWithChan(request *WhereInDimQueryRequest) (<-chan *WhereInDimQueryResponse, <-chan error)
• type WhereInDimQueryDimensions
• type WhereInDimQueryRequest
  • func CreateWhereInDimQueryRequest() (request *WhereInDimQueryRequest)
• type WhereInDimQueryResponse
  • func CreateWhereInDimQueryResponse() (response *WhereInDimQueryResponse)

Types

type ARMSQueryDataSetDimensions

type ARMSQueryDataSetDimensions struct {
	Key   string `name:"Key"`
	Value string `name:"Value"`
	Type  string `name:"Type"`
}

ARMSQueryDataSetDimensions is a repeated param struct in ARMSQueryDataSetRequest

type ARMSQueryDataSetOptionalDims

type ARMSQueryDataSetOptionalDims struct {
	Key   string `name:"Key"`
	Value string `name:"Value"`
	Type  string `name:"Type"`
}

ARMSQueryDataSetOptionalDims is a repeated param struct in ARMSQueryDataSetRequest

type ARMSQueryDataSetRequest

type ARMSQueryDataSetRequest struct {
	*requests.RpcRequest
	DatasetId     requests.Integer                `position:"Query" name:"DatasetId"`
	IntervalInSec requests.Integer                `position:"Query" name:"IntervalInSec"`
	DateStr       requests.Integer                `position:"Query" name:"DateStr"`
	MinTime       requests.Integer                `position:"Query" name:"MinTime"`
	MaxTime       requests.Integer                `position:"Query" name:"MaxTime"`
	Dimensions    *[]ARMSQueryDataSetDimensions   `position:"Query" name:"Dimensions"  type:"Repeated"`
	Measures      *[]string                       `position:"Query" name:"Measures"  type:"Repeated"`
	IsDrillDown   requests.Boolean                `position:"Query" name:"IsDrillDown"`
	OrderByKey    string                          `position:"Query" name:"OrderByKey"`
	Limit         requests.Integer                `position:"Query" name:"Limit"`
	ReduceTail    requests.Boolean                `position:"Query" name:"ReduceTail"`
	HungryMode    requests.Boolean                `position:"Query" name:"HungryMode"`
	RequiredDims  *[]ARMSQueryDataSetRequiredDims `position:"Query" name:"RequiredDims"  type:"Repeated"`
	OptionalDims  *[]ARMSQueryDataSetOptionalDims `position:"Query" name:"OptionalDims"  type:"Repeated"`
}

ARMSQueryDataSetRequest is the request struct for api ARMSQueryDataSet

func CreateARMSQueryDataSetRequest

func CreateARMSQueryDataSetRequest() (request *ARMSQueryDataSetRequest)

CreateARMSQueryDataSetRequest creates a request to invoke ARMSQueryDataSet API

type ARMSQueryDataSetRequiredDims

type ARMSQueryDataSetRequiredDims struct {
	Key   string `name:"Key"`
	Value string `name:"Value"`
	Type  string `name:"Type"`
}

ARMSQueryDataSetRequiredDims is a repeated param struct in ARMSQueryDataSetRequest

type ARMSQueryDataSetResponse

type ARMSQueryDataSetResponse struct {
	*responses.BaseResponse
	Data string `json:"Data" xml:"Data"`
}

ARMSQueryDataSetResponse is the response struct for api ARMSQueryDataSet

func CreateARMSQueryDataSetResponse

func CreateARMSQueryDataSetResponse() (response *ARMSQueryDataSetResponse)

CreateARMSQueryDataSetResponse creates a response to parse from ARMSQueryDataSet response

type Client

type Client struct {
	sdk.Client
}

Client is the sdk client struct, each func corresponds to an OpenAPI

func NewClient

func NewClient() (client *Client, err error)

NewClient creates a sdk client with environment variables

func NewClientWithAccessKey

func NewClientWithAccessKey(regionId, accessKeyId, accessKeySecret string) (client *Client, err error)

NewClientWithAccessKey is a shortcut to create sdk client with accesskey usage: https://help.aliyun.com/document_detail/66217.html

func NewClientWithEcsRamRole

func NewClientWithEcsRamRole(regionId string, roleName string) (client *Client, err error)

NewClientWithEcsRamRole is a shortcut to create sdk client with ecs ram role usage: https://help.aliyun.com/document_detail/66223.html

func NewClientWithOptions

func NewClientWithOptions(regionId string, config *sdk.Config, credential auth.Credential) (client *Client, err error)

NewClientWithOptions creates a sdk client with regionId/sdkConfig/credential this is the common api to create a sdk client

func NewClientWithRamRoleArn

func NewClientWithRamRoleArn(regionId string, accessKeyId, accessKeySecret, roleArn, roleSessionName string) (client *Client, err error)

NewClientWithRamRoleArn is a shortcut to create sdk client with ram roleArn usage: https://help.aliyun.com/document_detail/66222.html

func NewClientWithRsaKeyPair

func NewClientWithRsaKeyPair(regionId string, publicKeyId, privateKey string, sessionExpiration int) (client *Client, err error)

NewClientWithRsaKeyPair is a shortcut to create sdk client with rsa key pair attention: rsa key pair auth is only Japan regions available

func NewClientWithStsToken

func NewClientWithStsToken(regionId, stsAccessKeyId, stsAccessKeySecret, stsToken string) (client *Client, err error)

NewClientWithStsToken is a shortcut to create sdk client with sts token usage: https://help.aliyun.com/document_detail/66222.html

func (*Client) ARMSQueryDataSet

func (client *Client) ARMSQueryDataSet(request *ARMSQueryDataSetRequest) (response *ARMSQueryDataSetResponse, err error)

ARMSQueryDataSet invokes the arms.ARMSQueryDataSet API synchronously api document: https://help.aliyun.com/api/arms/armsquerydataset.html

func (*Client) ARMSQueryDataSetWithCallback

func (client *Client) ARMSQueryDataSetWithCallback(request *ARMSQueryDataSetRequest, callback func(response *ARMSQueryDataSetResponse, err error)) <-chan int

ARMSQueryDataSetWithCallback invokes the arms.ARMSQueryDataSet API asynchronously api document: https://help.aliyun.com/api/arms/armsquerydataset.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) ARMSQueryDataSetWithChan

func (client *Client) ARMSQueryDataSetWithChan(request *ARMSQueryDataSetRequest) (<-chan *ARMSQueryDataSetResponse, <-chan error)

ARMSQueryDataSetWithChan invokes the arms.ARMSQueryDataSet API asynchronously api document: https://help.aliyun.com/api/arms/armsquerydataset.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) WhereInDimQuery

func (client *Client) WhereInDimQuery(request *WhereInDimQueryRequest) (response *WhereInDimQueryResponse, err error)

WhereInDimQuery invokes the arms.WhereInDimQuery API synchronously api document: https://help.aliyun.com/api/arms/whereindimquery.html

func (*Client) WhereInDimQueryWithCallback

func (client *Client) WhereInDimQueryWithCallback(request *WhereInDimQueryRequest, callback func(response *WhereInDimQueryResponse, err error)) <-chan int

WhereInDimQueryWithCallback invokes the arms.WhereInDimQuery API asynchronously api document: https://help.aliyun.com/api/arms/whereindimquery.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

func (*Client) WhereInDimQueryWithChan

func (client *Client) WhereInDimQueryWithChan(request *WhereInDimQueryRequest) (<-chan *WhereInDimQueryResponse, <-chan error)

WhereInDimQueryWithChan invokes the arms.WhereInDimQuery API asynchronously api document: https://help.aliyun.com/api/arms/whereindimquery.html asynchronous document: https://help.aliyun.com/document_detail/66220.html

type WhereInDimQueryDimensions

type WhereInDimQueryDimensions struct {
	Key   string `name:"Key"`
	Value string `name:"Value"`
	Type  string `name:"Type"`
}

WhereInDimQueryDimensions is a repeated param struct in WhereInDimQueryRequest

type WhereInDimQueryRequest

type WhereInDimQueryRequest struct {
	*requests.RpcRequest
	DatasetId     requests.Integer             `position:"Query" name:"DatasetId"`
	IntervalInSec requests.Integer             `position:"Query" name:"IntervalInSec"`
	DateStr       string                       `position:"Query" name:"DateStr"`
	MinTime       requests.Integer             `position:"Query" name:"MinTime"`
	MaxTime       requests.Integer             `position:"Query" name:"MaxTime"`
	Dimensions    *[]WhereInDimQueryDimensions `position:"Query" name:"Dimensions"  type:"Repeated"`
	WhereInKey    string                       `position:"Query" name:"WhereInKey"`
	WhereInValues *[]string                    `position:"Query" name:"WhereInValues"  type:"Repeated"`
	Measures      *[]string                    `position:"Query" name:"Measures"  type:"Repeated"`
	IsDrillDown   requests.Boolean             `position:"Query" name:"IsDrillDown"`
	OrderByKey    string                       `position:"Query" name:"OrderByKey"`
	Limit         requests.Integer             `position:"Query" name:"Limit"`
	ReduceTail    requests.Boolean             `position:"Query" name:"ReduceTail"`
}

WhereInDimQueryRequest is the request struct for api WhereInDimQuery

func CreateWhereInDimQueryRequest

func CreateWhereInDimQueryRequest() (request *WhereInDimQueryRequest)

CreateWhereInDimQueryRequest creates a request to invoke WhereInDimQuery API

type WhereInDimQueryResponse

type WhereInDimQueryResponse struct {
	*responses.BaseResponse
	Data string `json:"Data" xml:"Data"`
}

WhereInDimQueryResponse is the response struct for api WhereInDimQuery

func CreateWhereInDimQueryResponse

func CreateWhereInDimQueryResponse() (response *WhereInDimQueryResponse)

CreateWhereInDimQueryResponse creates a response to parse from WhereInDimQuery response