GetApiKey - 获取API Key - 日志服务

接口说明

请求说明

该 API 用于通过apiKeyName获取指定 ApiKey 的详细信息。
返回的信息包括 ApiKey 的名称、密钥、状态、描述、允许写入的存储列表、创建时间和更新时间。
log:GetApiKey被视为敏感权限，调用时需谨慎。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

log:GetApiKey

get

*Project

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

无

请求语法

GET /apikeys/{apiKeyName} HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
apiKeyName	string	是	API Key 名称	demo-apikey-001

请求参数

名称	类型	必填	描述	示例值
project	string	否	Project 名称	test

返回参数

名称	类型	描述	示例值
	object	响应参数
apiKeyName	string	API Key 名称	demo-apikey-001
apiKey	string	ApiKey 明文
status	string	状态	Enabled / Disabled
description	string	描述	test
allowedStores	array	允许写入的 LogStore 列表
	string	LogStore 名称	test
createTime	integer	创建时间	1788420000
updateTime	integer	更新时间	1788420000

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。