GetApiKey - Simple Log Service - Alibaba Cloud Documentation Center

Operation description

Description

This operation retrieves the details of a specified API key by using apiKeyName.
The returned information includes the name, key, status, description, list of data stores that allow writes, creation time, and update time of the API key.
log:GetApiKey is considered a sensitive permission. Exercise caution when calling this operation.

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

log:GetApiKey

get

*Project

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/apikey/{#ApiKeyName}

None

Request syntax

GET /apikeys/{apiKeyName} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
apiKeyName	string	Yes	The API key name.	demo-apikey-001

Request parameters

Parameter	Type	Required	Description	Example
project	string	No	The project name.	test

Response elements

Element	Type	Description	Example
	object	The response parameters.
apiKeyName	string	The API key name.	demo-apikey-001
apiKey	string	The API key in plaintext.
status	string	The status.	Enabled / Disabled
description	string	The description.	test
allowedStores	array	The list of Logstores that allow writes.
	string	The Logstore name.	test
createTime	integer	The creation time.	1788420000
updateTime	integer	The update time.	1788420000

Examples

Success response

JSON format

{
  "apiKeyName": "demo-apikey-001",
  "apiKey": "",
  "status": "Enabled / Disabled",
  "description": "test",
  "allowedStores": [
    "test"
  ],
  "createTime": 1788420000,
  "updateTime": 1788420000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.