ListApiKeys - Simple Log Service - Alibaba Cloud Documentation Center

Operation description

Request description

Use the allowedStore parameter to filter the returned API keys. Only API keys that are allowed to write to the specified Logstore or Metricstore are returned.
If you do not specify the allowedStore parameter, all API keys in the project are returned.
The log:ListApiKeys permission is considered a sensitive permission and should be granted with caution.

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

GET /apikeys HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
allowedStore	string	No	The Logstore that the API key is allowed to write to.	test
size	integer	No	The number of entries per page.	10
offset	integer	No	The number of the page to return.	1
project	string	No	The name of the project.	test

Response elements

Element	Type	Description	Example
	object	The response data.
apiKeys	array<object>	The list of API keys.
	object	The API key information.
apiKeyName	string	The name of the API key.	demo-apikey-001
apiKey	string	The plaintext of the API key.
status	string	The status of the API key.	Enabled
description	string	The description of the API key.	test
allowedStores	array	The list of Logstores that the API key is allowed to write to.
	string	The name of the Logstore.	test
createTime	integer	The time when the API key was created.	1788420000
updateTime	integer	The time when the API key was last updated.	1788420000
count	integer	The number of API keys on the current page.	10
total	integer	The total number of API keys.	20

Examples

Success response

JSON format

{
  "apiKeys": [
    {
      "apiKeyName": "demo-apikey-001",
      "apiKey": "",
      "status": "Enabled",
      "description": "test",
      "allowedStores": [
        "test"
      ],
      "createTime": 1788420000,
      "updateTime": 1788420000
    }
  ],
  "count": 10,
  "total": 20
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.