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

查询密钥列表

功能介绍

查询密钥列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/edgemgr/secrets

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

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，专业版实例为空值

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

secrets

Array of SecretDetailResp objects

密钥

count

Integer

满足条件的个数
表5 SecretDetailResp

参数

参数类型

描述

id

String

密钥ID

name

String

密钥名称，以小写英文字母开头，4-64位，可以使用小写英文、数字、中划线（-），不能以中划线结尾

description

String

密钥描述，最大长度255，不允许^ ~ # $ % & * < > ( ) [ ] { } ' " \

secrets

Map<String,String>

secrets是一个字典，由多个键值对组成，json化后最大总长度为1048576，key和value均为字符串。键值对中key由大小写字母或中划线开头，由数字、大小写字母、点号（.）、中划线（-）、下划线（_）组成，最小长度为1，最大长度63个字符， 键值对中的value必须为base64字符。注：secrets字典的长度即字典转为标准的字符串后的长度，例如字典{"a": "b"}转为标准字符串后为'{"a": "b"}'，长度为10

project_id

String

项目ID

created_at

String

创建时间

updated_at

String

更新时间

type

String

密钥类型，目前只支持“Opaque”类型

请求示例

无

响应示例

状态码： 200

ok

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

状态码

状态码

描述

200

ok

错误码

请参见错误码。

父主题： 密钥管理

相关文档