DescribeApikeyAttribute

Queries the details of a specified API key.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ApiKey	string	Yes	The plaintext API key.	6c4b1f0317cd4fd7a5b446d3503d**
RegionId	string	Yes	The region ID.	cn-hangzhou
PageSize	integer	No	The number of entries per page. Valid values: 30, 50, and 100. Default value: 30.	30
PageNumber	integer	No	The page number. Default value: 1.	1

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	F3322AFE-083E-4D77-A074-421301******
Items	array<object>	The list of consumer objects.
	array<object>	The consumer object.
Consumer	object	The consumer information.
ConsumerId	string		c-71qh3pscbd3i
GwClusterId	string		pg-2ze5n62ef4s165***
Name	string		test
ConsumerGroupId	string		cg-bq6rcdjp02vt
ConsumerTag	string		test
ApiKey	string		***
Status	string		Enabled
CreateTime	string		2021-07-18T07:32:30Z
ModifyTime	string		2026-04-10T01:48:25Z
UsageStatistics	array<object>	The usage statistics for the consumer.
	object	The usage statistics for the consumer.
GwClusterId	string		pg-bp1ln7w98yrhzz7i2
DimensionType	string		Consumer
DimensionRefId	string		c-xxxxxx
TotalInputToken	string		10
TotalOutputToken	string		10
TotalCacheToken	string		10
TotalCostPoints	string		10
MonthlyInputToken	string		10
MonthlyOutputToken	string		10
MonthlyCacheToken	string		10
MonthlyCostPoints	string		10
TotalToken	string		10
MonthlyToken	string		10

Examples

Success response

JSON format

{
  "RequestId": "F3322AFE-083E-4D77-A074-421301******",
  "Items": [
    {
      "Consumer": {
        "ConsumerId": "c-71qh3pscbd3i",
        "GwClusterId": "pg-2ze5n62ef4s165***",
        "Name": "test",
        "ConsumerGroupId": "cg-bq6rcdjp02vt",
        "ConsumerTag": "test",
        "ApiKey": "***",
        "Status": "Enabled",
        "CreateTime": "2021-07-18T07:32:30Z",
        "ModifyTime": "2026-04-10T01:48:25Z"
      },
      "UsageStatistics": [
        {
          "GwClusterId": "pg-bp1ln7w98yrhzz7i2",
          "DimensionType": "Consumer\n\n",
          "DimensionRefId": "c-xxxxxx",
          "TotalInputToken": "10",
          "TotalOutputToken": "10",
          "TotalCacheToken": "10",
          "TotalCostPoints": "10",
          "MonthlyInputToken": "10",
          "MonthlyOutputToken": "10",
          "MonthlyCacheToken": "10",
          "MonthlyCostPoints": "10",
          "TotalToken": "10",
          "MonthlyToken": "10"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.