ListSecrets - 列出密钥

更新时间:
复制为 MD 格式

列出密钥。

接口说明

接口支持创建多个服务。

调试

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

授权信息

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

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

请求语法

GET /v1/secrets HTTP/1.1

请求参数

名称类型必填描述示例值
nameLikestring

密钥名称,模糊搜索。

my_secret
pageNumberinteger

分页页码。

1
pageSizeinteger

分页大小,有效范围[1, 100],不填默认 10。

10
gatewayTypestring

网关类型过滤,目前支持 AIAPI 两种网关类型。

AI

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

3A3D1392-0F71-5A10-9AE8-89C434696966
codestring

响应状态码。

Ok
messagestring

响应消息,

success
dataobject

密钥信息列表。

totalSizeinteger

总数量。

10
pageNumberinteger

分页页码。

1
pageSizeinteger

分页大小。

10
itemsarray<object>

密钥详情列表。

itemobject

密钥详情。

secretIdstring

密钥 ID。

sec-d5e6shmm1hkoxxxxxxxx
namestring

密钥名称。

my_secret
secretSourcestring

密钥来源。

KMS
createTimestamplong

创建时间戳。

1725617840096
updateTimestamplong

更新时间戳。单位: 毫秒。

1721116090326
kmsConfigKMSConfig

KMS 配置信息。

gatewayTypestring

网关类型。

API
statusstring

密钥状态:

  • ENABLE:已启用;
  • DISABLE:不可用;
  • DELETED:已删除。
ENABLE
referenceCountinteger

引用当前密钥的资源数量。

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
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2026-01-07新增 OpenAPI查看变更详情