QueryUsageStatisticsByTagId-阿里云帮助中心

Queries usage statistics by tag ID.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dytns:QueryUsageStatisticsByTagId

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
BeginTime	string	No	The start time of the query.	20230308
EndTime	string	No	The end time of the query.	20230406
TagId	integer	No	The tag ID.	89
PageNo	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	10

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	D45CC751-34DF-5797-81FB-9A2ED6DC024B
Message	string	The description of the status code.	OK
Data	array<object>	The returned data.
	object	The returned data.
AuthorizationCode	string	The authorization code.	g61I8UV5zd
SuccessTotal	integer	The number of successful queries.	93
FailTotal	integer	The number of failed queries.	71
TagName	string	The tag name.	阿里云查询
SceneName	string	The scenario name.	电话回访1
Total	integer	The total number of queries.	41
TagId	integer	The tag ID.	69
PartnerId	integer	The customer's PID.	10000013****071
Id	integer	The ID of the usage record for the authorization code.	4d32c9ef-c8b0-4d69-a437-cca5****185d
GmtDateStr	string	The time when the record was created.	20230312
IndustryName	string	The industry name.	家政安保
Code	string	The status code of the request. A value of OK indicates that the request was successful.	OK
Success	boolean	Indicates whether the call was successful. true: The call was successful. false: The call failed.	true

Examples

Success response

JSON format

{
  "RequestId": "D45CC751-34DF-5797-81FB-9A2ED6DC024B",
  "Message": "OK",
  "Data": [
    {
      "AuthorizationCode": "g61I8UV5zd",
      "SuccessTotal": 93,
      "FailTotal": 71,
      "TagName": "阿里云查询",
      "SceneName": "电话回访1",
      "Total": 41,
      "TagId": 69,
      "PartnerId": 0,
      "Id": 0,
      "GmtDateStr": "20230312",
      "IndustryName": "家政安保"
    }
  ],
  "Code": "OK",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.
400	AuthCodeIllegal	Illegal authCode.
500	InternalError	A system error occurred.
500	RequestTimeout	Request supplier timed out.	Request supplier timeout
500	RequestSupplierError	Request supplier error.	Request supplier error.

See for a complete list.

Release notes

See Release Notes for a complete list.