文档首页/ 智能边缘平台 IEF/ API参考/ API/ 密钥管理/ 查询密钥列表 - ShowSecret
更新时间：2025-11-18 GMT+08:00
查看PDF
分享

查询密钥列表 - ShowSecret

功能介绍

该API用于查询密钥列表。

URI

GET /v2/{project_id}/edgemgr/secrets?{name=xxx,limit=xxx,offset=xxx,sort=xxx}

表1 Path参数

名称

是否必选

说明

project_id

是

项目ID，获取方法请参见获取项目ID。
表2 查询参数

名称

是否必选

参数类型

说明

name

否

String

密钥名称，模糊匹配

limit

否

String

每页显示的条目数量，取值范围1~1000，默认值为1000。

offset

否

String

查询的起始位置，取值范围为非负整数，默认为0

sort

否

String

排序方式，可根据名称、创建时间、更新时间排序

枚举值：

  • name
  • created_at
  • updated_at

默认升序，如sort=name，降序：sort=name%3Adesc
  • 如果不携带任何检索参数，将返回该租户的所有密钥配置信息。
  • 可以同时携带多个检索参数，同时生效。

请求消息

表3 请求Header参数

参数

是否必选

类型

描述

Content-Type

是

String

消息体的类型（格式）

推荐您使用默认值application/json。

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

ief-instance-id

否

String

企业版实例ID，专业版实例为空值

响应消息

响应参数

表4 响应Body参数

名称

参数类型

说明

secrets

Array of 表5 object

密钥列表

count

Integer

满足条件的个数
表5 secret

名称

参数类型

说明

id

String

密钥ID

name

String

密钥名称

description

String

密钥描述

secrets

Map<String, String>

密钥列表

project_id

String

项目ID

created_at

String

创建时间

updated_at

String

更新时间

type

String

密钥类型

响应示例

{
    "count": 1,
    "secrets": [
        {
            "id": "12ns9eb6cc0d49a0941df2f31283mds8 ",
            "name": "test-secret",
            "description": "this is a test secret",
            "secrets": {
                "key1": "val1",
                "key3": "val3"
            },
            "project_id": "d16e6eb6cc0d49a0941df2f31285757a",
            "created_at": "2018-07-16T13:41:25.347335",
            "updated_at": "2018-07-19T13:41:25.347335",
            "type": "Opaque"
        }
    ]
}

错误码

请参见错误码。

父主题： 密钥管理