DescribeGatewayApikeyList

Queries all API keys under the current UID.

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
PageNumber	integer	No	The page number. Default value: 1.	1
PageSize	integer	No	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
RegionId	string	Yes	The region ID.	cn-beijing

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	A0450B18-BBD4-5DF9-8E71-610F1A921CDE
TotalRecordCount	integer	The total number of records.	1
PageRecordCount	integer	The number of records on the current page.	1
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page. Valid values: 30 50 100 Default value: 30.	30
TotalPages	integer	The total number of pages.	1
Items	array<object>	The list of consumer objects.
	object	The consumer object.
ConsumerId	string	The user ID.	c-mqveroemc***
Name	string	The username.	test
ConsumerGroupId	string	The user group ID.	cg-xxxxxx
ConsumerTag	string	The consumer tag.	test
ApiKey	string	The API key in use.	xxxxxxxx
GwClusterId	string	The gateway instance ID.	pg-xxxxxxxx
CreateTime	string	The creation time.	2020-08-14T05:58:42Z
ModifyTime	string	The last modification time.	2024-10-29T09:31:37Z

Examples

Success response

JSON format

{
  "RequestId": "A0450B18-BBD4-5DF9-8E71-610F1A921CDE",
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "TotalPages": 1,
  "Items": [
    {
      "ConsumerId": "c-mqveroemc***",
      "Name": "test",
      "ConsumerGroupId": "cg-xxxxxx",
      "ConsumerTag": "test",
      "ApiKey": "xxxxxxxx",
      "GwClusterId": "pg-xxxxxxxx",
      "CreateTime": "2020-08-14T05:58:42Z",
      "ModifyTime": "2024-10-29T09:31:37Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.