ListSecrets - 列出密钥-API 网关(API Gateway)-阿里云帮助中心

列出密钥。

接口说明

接口支持创建多个服务。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

apig:ListSecrets

list

*全部资源

*

无

请求语法

GET /v1/secrets HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
nameLike	string	否	密钥名称，模糊搜索。	my_secret
pageNumber	integer	否	分页页码。	1
pageSize	integer	否	分页大小，有效范围[1, 100]，不填默认 10。	10
gatewayType	string	否	网关类型过滤，目前支持 AI、API 两种网关类型。	AI

返回参数

名称	类型	描述	示例值
	object	Schema of Response
requestId	string	Id of the request	3A3D1392-0F71-5A10-9AE8-89C434696966
code	string	响应状态码。	Ok
message	string	响应消息，	success
data	object	密钥信息列表。
totalSize	integer	总数量。	10
pageNumber	integer	分页页码。	1
pageSize	integer	分页大小。	10
items	array<object>	密钥详情列表。
	object	密钥详情。
secretId	string	密钥 ID。	sec-d5e6shmm1hkoxxxxxxxx
name	string	密钥名称。	my_secret
secretSource	string	密钥来源。	KMS
createTimestamp	integer	创建时间戳。	1725617840096
updateTimestamp	integer	更新时间戳。单位: 毫秒。	1721116090326
kmsConfig	KMSConfig	KMS 配置信息。
gatewayType	string	网关类型。	API
status	string	密钥状态： ENABLE：已启用； DISABLE：不可用； DELETED：已删除。	ENABLE
referenceCount	integer	引用当前密钥的资源数量。	3

示例

正常返回示例

JSON格式

{
  "requestId": "3A3D1392-0F71-5A10-9AE8-89C434696966",
  "code": "Ok",
  "message": "success",
  "data": {
    "totalSize": 10,
    "pageNumber": 1,
    "pageSize": 10,
    "items": [
      {
        "secretId": "sec-d5e6shmm1hkoxxxxxxxx",
        "name": "my_secret",
        "secretSource": "KMS",
        "createTimestamp": 1725617840096,
        "updateTimestamp": 1721116090326,
        "kmsConfig": {
          "kmsInstanceId": "kst-xxxxxxxx",
          "kmsKeyId": "key-xxxxxxxx"
        },
        "gatewayType": "API",
        "status": "ENABLE",
        "referenceCount": 3
      }
    ]
  }
}

错误码

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

变更历史

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