文档首页/ 数据加密服务 DEW/ API参考/ API说明/ 管理加密密钥/ 别名管理/ 查询密钥关联的别名
更新时间：2024-11-20 GMT+08:00
查看PDF
分享

查询密钥关联的别名

功能介绍

查询一个密钥关联的所有别名

调用方法

请参见如何调用API。

URI

GET /v1.0/{project_id}/kms/aliases

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

key_id

否

String

密钥ID

limit

否

String

指定查询返回记录条数

marker

否

String

分页查询起始位置标识

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

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

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

[数组元素]

Array<Array<ListAliasResponseBody>>

查询别名响应消息体
表5 ListAliasResponseBody

参数

参数类型

描述

aliases

Array of AliasEntity objects

密钥关联的所有别名

page_info

PageInfo object

分页信息
表6 AliasEntity

参数

参数类型

描述

domain_id

String

账号ID

key_id

String

密钥ID

alias

String

别名

alias_urn

String

别名资源定位符

create_time

String

创建时间

update_time

String

更新时间
表7 PageInfo

参数

参数类型

描述

next_marker

String

下一页的查询标志

current_count

Integer

本页返回条目数量

请求示例

无

响应示例

状态码： 200

查询别名响应消息体

{
  "aliases" : [ {
    "domain_id" : "3bab8e245e854f68af5967c00dd43127",
    "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "alias" : "kms-1234",
    "alias_urn" : "kms:cn-north-7:3bab8e245e854f68af5967c00dd43127:alias:kms-1234",
    "create_time" : "2024-04-01T00:00:00Z",
    "update_time" : "2024-04-01T00:00:00Z"
  } ],
  "page_info" : {
    "next_marker" : "",
    "current_count" : 1
  }
}

状态码

状态码

描述

200

查询别名响应消息体

错误码

请参见错误码。

父主题： 别名管理

相关文档