华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_id 是 String 密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 secrets Array of Secret objects 凭据详情列表。 page_info PageInfo object 分页信息。 表5 Secret 参数 参数类型 描述 id String 凭据的资源标识符。 name String 凭据名称。 state String 凭据状态，取值如下： ENABLED：表示启用状态 DISABLED：表示禁用状态 PENDING_DELETE：表示待删除状态 FROZEN：表示冻结状态 kms_key_id String 用于加密凭据值的KMS主密钥的ID值。 description String 凭据的描述信息。 create_time Long 凭据创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Long 凭据上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 scheduled_delete_time Long 凭据计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 凭据不在删除计划中时，本项值为null。 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）。 previous_marker String 本页的起始凭据名称，上一页末尾凭据名称。 current_count Integer 本页返回条目数量。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 502 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 504 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 请求已成功 { "secrets" : [ { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "name" : "secret-name-test", "state" : "ENABLED", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "description" : "description", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000 } ], "page_info" : { "next_marker" : "secret-name-test", "previous_marker" : "secret-name-test", "current_count" : 1 }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 secret Secret object 凭据对象。 表4 Secret 参数 参数类型 描述 id String 凭据的资源标识符。 name String 凭据名称。 state String 凭据状态，取值如下： ENABLED：表示启用状态 DISABLED：表示禁用状态 PENDING_DELETE：表示待删除状态 FROZEN：表示冻结状态 kms_key_id String 用于加密凭据值的KMS主密钥的ID值。 description String 凭据的描述信息。 create_time Long 凭据创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Long 凭据上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 scheduled_delete_time Long 凭据计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 凭据不在删除计划中时，本项值为null。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 502 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 504 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 请求已成功 { "secret" : { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "name" : "test", "state" : "ENABLED", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "description" : "description", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000 }}

响应示例 状态码： 200 请求已成功 { "total_count" : 1, "resources" : [ { "resource_id" : "2d1152f2-290d-4756-a1d2-e12c14992416" }, { "resource_detail" : { "id" : "2d1152f2-290d-4756-a1d2-e12c14992416", "name" : "example_name", "state" : "ENABLED", "description" : "", "kms_key_id" : "1213d410-ass1-1254-1a2d-3cca2sa2w554", "create_time" : 1581507580000, "update_time" : 1581507580000, "scheduled_delete_time" : 1581507580000 } }, { "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key2", "value" : "value2" } ] }, { "sys_tags" : null }, { "resource_name" : "example_name" } ]}

响应示例 状态码： 200 请求已成功 { "version_metadatas" : [ { "id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "create_time" : 1581507580000, "secret_name" : "secret-name-demo", "version_stages" : [ "pending", "used" ] } ], "page_info" : { "next_marker" : "v10", "previous_marker" : "v1", "current_count" : 10 }}

URI GET /v1/{project_id}/secrets/{secret_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 secret_name 是 String 凭据名称。 表2 Query参数 参数 是否必选 参数类型 描述 marker 否 String 分页参数，取值为上一页数据的最后一条记录的版本号。 limit 否 Integer 每页显示的条目数量。默认值50。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 version_metadatas Array of VersionMetadata objects version_metadata对象。 page_info PageInfo object 分页信息。 表5 VersionMetadata 参数 参数类型 描述 id String 凭据的版本号标识符，凭据对象下唯一。 create_time Long 凭据版本创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 kms_key_id String 加密版本凭据值的KMS主密钥ID。 secret_name String 凭据名称。 version_stages Array of strings 凭据版本被标记的状态列表。每个版本标签对于凭据对象下版本是唯一存在的，如果你创建版本时，指定的是同一凭据对象下的一个已经标记在其他版本上的状态，该标签将自动从其他版本上删除，并附加到此版本上。 如果未指定version_stage的值，则凭据管理服务会自动移动临时标签SYSCURRENT到此新版本。 表6 PageInfo 参数 参数类型 描述 next_marker String 下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）。 previous_marker String 本页的起始凭据名称，上一页末尾凭据名称。 current_count Integer 本页返回条目数量。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 502 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 504 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK。 { "total" : 1, "tasks" : [ { "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c", "operate_type" : "RUNNING_RESET", "task_time" : "1523342130000", "server_name" : "Test", "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006", "keypair_name" : "KeyPair-xt" } ]} 状态码： 400 Error response。 { "error_code" : "KPS.XXX", "error_msg" : "XXX"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 total Integer 正在处理的任务总数。 tasks Array of RunningTasks objects 正在处理的任务列表。 表4 RunningTasks 参数 参数类型 描述 task_id String 虚拟机ID。 operate_type String 操作类型。 FAILED_RESET 重置 FAILED_REPLACE 替换 FAILED_UNBIND 解绑 task_time String 任务时间。 server_name String 虚拟机名称。 server_id String 虚拟机ID。 keypair_name String 密钥对名称。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 请求已成功 { "grants" : [ { "operations" : [ "create-datakey", "describe-key" ], "issuing_principal" : "8b961fb414344d59825ba0c8c008c815", "key_id" : "737fd52b-36c4-4c91-972e-f6e202de9f6e", "grant_id" : "dd3f03e9229a5e47a41be6c27a630e60d5cbdbad2be89465d63109ad034db7d8", "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "name" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "creation_date" : "1597062260000", "grantee_principal_type" : "user" } ], "next_marker" : "", "total" : 1, "truncated" : "false"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 String 指定查询可退役授权返回记录条数，如果查询记录条数小于存在的条数，响应参数“truncated”将返回“true”，表示存在分页。 取值在授权最大个数范围以内。例如：100 marker 否 String 分页查询起始位置标识。 分页查询收到的响应参数“truncated”为“true”时，可以发送连续的请求获取更多的记录条数，“marker”设置为响应的“next_marker”的值。例如：10。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 grants Array of Grants objects grant列表，详情请参见grants字段数据结构说明。 next_marker String 获取下一页所需要传递的marker值。 当“truncated”为“false”时，“next_marker”为空。 total Integer 可退役授权总条数。 truncated String 是否还有下一页： “true”表示还有数据。 “false”表示已经是最后一页。 表5 Grants 参数 参数类型 描述 key_id String 密钥ID。 grant_id String 授权ID，64字节。 grantee_principal String 被授权用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 grantee_principal_type String 授权类型。 有效值：“user”，“domain”。 operations Array of strings 授权允许的操作列表。 有效的值：“create-datakey”，“create-datakey-without-plaintext”，“encrypt-datakey”，“decrypt-datakey”，“describe-key”，“create-grant”，“retire-grant”，“encrypt-data”，“decrypt-data”。 有效值不能仅为“create-grant”。 “create-datakey” 创建数据密钥 “create-datakey-without-plaintext” 创建不含明文数据密钥 “encrypt-datakey” 加密数据密钥 “decrypt-datakey” 解密数据密钥 “describe-key” 查询密钥信息 “retire-grant” 退役授权 “encrypt-data” 加密数据 “decrypt-data” 解密数据 issuing_principal String 创建授权用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 creation_date String 创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 例如：1497341531000 name String 授权名字，取值1到255字符，满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”。 retiring_principal String 可退役授权的用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应示例 状态码： 200 请求已成功 { "resources" : [ { "resource_id" : "90c03e67-5534-4ed0-acfa-89780e47a535", "resource_detail" : [ { "key_id" : "90c03e67-5534-4ed0-acfa-89780e47a535", "domain_id" : "4B688Fb77412Aee5570E7ecdbeB5afdc", "key_alias" : "tagTest_xmdmi", "key_description" : "123", "creation_date" : 1521449277000, "scheduled_deletion_date" : "", "key_state" : 2, "default_key_flag" : 0, "key_type" : 1, "key_rotation_enabled" : false, "expiration_time" : "", "origin" : "kms", "sys_enterprise_project_id" : "0", "realm" : "test" } ], "resource_name" : "tagTest_xmdmi", "tags" : [ { "key" : "key", "value" : "testValue!" }, { "key" : "haha", "value" : "testValue" } ] } ], "total_count" : 1}

响应示例 状态码： 200 请求已成功 { "keys" : [ "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "2e258389-bb1e-4568-a1d5-e1f50adf70ea" ], "key_details" : [ { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "cn-north-7", "key_description" : "key_description", "creation_date" : "1502799822000", "scheduled_deletion_date" : "", "key_spec" : "AES_256", "key_usage" : "ENCRYPT_DECRYPT", "key_state" : "2", "default_key_flag" : "0", "key_type" : "1", "expiration_time" : "1501578672000", "origin" : "kms", "key_rotation_enabled" : "true", "sys_enterprise_project_id" : "0", "partition_type" : "1" }, { "key_id" : "2e258389-bb1e-4568-a1d5-e1f50adf70ea", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "realm", "key_description" : "key_description", "creation_date" : "1502799822000", "scheduled_deletion_date" : "", "key_spec" : "AES_256", "key_usage" : "ENCRYPT_DECRYPT", "key_state" : "2", "default_key_flag" : "0", "key_type" : "1", "expiration_time" : "1501578672000", "origin" : "kms", "key_rotation_enabled" : "true", "sys_enterprise_project_id" : "0", "partition_type" : "1" } ], "next_marker" : "", "truncated" : "false", "total" : 2}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 keys Array of strings key_id列表。 key_details Array of KeyDetails objects 密钥详情列表。详情参见KeyDetails next_marker String 获取下一页所需要传递的“marker”值。当“truncated”为“false”时，“next_marker”为空。 truncated String 是否还有下一页： “true”表示还有数据。 “false”表示已经是最后一页。 total Integer 密钥总条数。 表5 KeyDetails 参数 参数类型 描述 key_id String 密钥ID。 domain_id String 用户域ID。 key_alias String 密钥别名。 realm String 密钥区域。 key_spec String 密钥生成算法。 AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 key_usage String 密钥用途。 ENCRYPT_DECRYPT SIGN_VERIFY key_description String 密钥描述。 creation_date String 密钥创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 scheduled_deletion_date String 密钥计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 key_state String 密钥状态，满足正则匹配“^[1-5]{1}$”，枚举如下： “1”表示待激活状态 “2”表示启用状态 “3”表示禁用状态 “4”表示计划删除状态 “5”表示等待导入状态 default_key_flag String 默认主密钥标识，默认主密钥标识为1，非默认标识为0。 key_type String 密钥类型。 expiration_time String 密钥材料失效时间，时间戳，即从1970年1月1日至该时间的总秒数。 origin String 密钥来源，默认为“kms”，枚举如下： kms表示密钥材料由kms生成kms表示密钥材料由kms生成 external表示密钥材料由外部导入 key_rotation_enabled String 密钥轮换状态，默认为“false”，表示关闭密钥轮换功能。 sys_enterprise_project_id String 企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 keystore_id String 密钥库ID key_label String 密钥在加密机中的标签 partition_type String 分区类型，枚举如下： 1为专业版 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 String 指定查询返回记录条数，如果指定查询记录条数小于存在的条数，响应参数“truncated”将返回“true”，表示存在分页。取值在密钥最大个数范围以内。例如：100 marker 否 String 分页查询起始位置标识。分页查询收到的响应参数“truncated”为“true”时，可以发送连续的请求获取更多的记录条数，“marker”设置为响应的next_marker的值。例如：10 key_state 否 String 密钥状态，满足正则匹配“^[1-5]{1}$”，枚举如下： “1”表示待激活状态 “2”表示启用状态 “3”表示禁用状态 “4”表示计划删除状态 “5”表示等待导入状态 key_spec 否 String 密钥生成算法，默认为“AES_256”。查询所有（包含非对称）密钥需要指定参数“ALL”。 AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 ALL enterprise_project_id 否 String 企业多项目ID。用户未开通企业多项目时，不需要输入该字段。 用户开通企业多项目时，查询资源可以输入该字段。 若用户不输入该字段，默认查询租户所有有权限的企业多项目下的资源。 此时“enterprise_project_id”取值为“all”。 若用户输入该字段，取值满足以下任一条件. 取值为“all” 取值为“0” 满足正则匹配：“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$” sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应示例 状态码： 200 请求已成功 { "grants" : [ { "operations" : [ "create-datakey", "describe-key" ], "issuing_principal" : "8b961fb414344d59825ba0c8c008c815", "key_id" : "737fd52b-36c4-4c91-972e-f6e202de9f6e", "grant_id" : "dd3f03e9229a5e47a41be6c27a630e60d5cbdbad2be89465d63109ad034db7d8", "grantee_principal" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "name" : "13gg44z4g2sglzk0egw0u726zoyzvrs8", "creation_date" : "1597062260000", "grantee_principal_type" : "user" } ], "next_marker" : "", "total" : 1, "truncated" : "false"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 grants Array of Grants objects grant列表，详情请参见grants字段数据结构说明。 next_marker String 获取下一页所需要传递的marker值。 当“truncated”为“false”时，“next_marker”为空。 truncated String 是否还有下一页： “true”表示还有数据。 “false”表示已经是最后一页。 total Integer grant总条数。 表5 Grants 参数 参数类型 描述 key_id String 密钥ID。 grant_id String 授权ID，64字节。 grantee_principal String 被授权用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 grantee_principal_type String 授权类型。 有效值：“user”，“domain”。 operations Array of strings 授权允许的操作列表。 有效的值：“create-datakey”，“create-datakey-without-plaintext”，“encrypt-datakey”，“decrypt-datakey”，“describe-key”，“create-grant”，“retire-grant”，“encrypt-data”，“decrypt-data”。 有效值不能仅为“create-grant”。 “create-datakey” 创建数据密钥 “create-datakey-without-plaintext” 创建不含明文数据密钥 “encrypt-datakey” 加密数据密钥 “decrypt-datakey” 解密数据密钥 “describe-key” 查询密钥信息 “retire-grant” 退役授权 “encrypt-data” 加密数据 “decrypt-data” 解密数据 issuing_principal String 创建授权用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 creation_date String 创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 例如：1497341531000 name String 授权名字，取值1到255字符，满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”。 retiring_principal String 可退役授权的用户ID，1~64字节，满足正则匹配“^[a-zA-Z0-9]{1，64}$”。 例如：0d0466b00d0466b00d0466b00d0466b0 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_id 是 String 密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 limit 否 String 指定查询授权列表返回记录条数，如果查询记录条数小于存在的条数，响应参数“truncated”将返回“true”，表示存在分页。 取值在授权最大个数范围以内。例如：100 marker 否 String 分页查询起始位置标识。 分页查询收到的响应参数“truncated”为“true”时，可以发送连续的请求获取更多的记录条数，“marker”设置为响应的“next_marker”的值。例如：10。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应示例 状态码： 200 OK。 { "keypair" : { "name" : "1hprr3TI", "id" : 116248, "type" : "ssh", "scope" : "user", "public_key" : "ssh-rsa AAAGenerated-by-Nova", "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0", "is_key_protection" : false, "deleted" : false, "description" : "12345", "user_id" : "6c2a33b1b8474d0dbac0a24297127525", "create_time" : 1581507580000, "delete_time" : null, "update_time" : null, "frozen_state" : 0 }} 状态码： 400 Error response。 { "error_code" : "KPS.XXX", "error_msg" : "XXX"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 keypair KeypairDetail object 密钥对详细信息。 表4 KeypairDetail 参数 参数类型 描述 name String SSH密钥对的名称。 id Integer SSH密钥对的ID。 type String SSH密钥对的类型。 scope String 租户级或者用户级。 public_key String SSH密钥对对应的publicKey信息。 fingerprint String SSH密钥对应指纹信息。 is_key_protection Boolean 是否托管密钥。 deleted Boolean SSH密钥对删除的标记。 description String SSH密钥对的描述信息。 user_id String SSH密钥对所属的用户信息。 create_time Integer SSH密钥对创建的时间，时间戳，即从1970年1月1日至该时间的总秒数。 delete_time Integer SSH密钥对删除的时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Integer SSH密钥对的更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 frozen_state Integer 冻结状态 0：正常状态 1：普通冻结 2：公安冻结 3：普通冻结及公安冻结 4：违规冻结 5：普通冻结及违规冻结 6：公安冻结及违规冻结 7：普通冻结、公安冻结及违规冻结 8：未实名认证冻结 9：普通冻结及未实名认证冻结 10：公安冻结及未实名认证冻结 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 keypairs Array of Keypairs objects SSH密钥对信息列表。 page_info PageInfo object 分页信息 表4 Keypairs 参数 参数类型 描述 keypair Keypair object 密钥对信息。 表5 Keypair 参数 参数类型 描述 name String SSH密钥对的名称。 type String SSH密钥对的类型，值为“ssh”或“x509”。 scope String 租户级或者用户级。 public_key String SSH密钥对对应的publicKey信息。 fingerprint String SSH密钥对应指纹信息。 is_key_protection Boolean 是否托管密钥。 frozen_state String 冻结状态 0：正常状态 1：普通冻结 2：公安冻结 3：普通冻结及公安冻结 4：违规冻结 5：普通冻结及违规冻结 6：公安冻结及违规冻结 7：普通冻结、公安冻结及违规冻结 8：未实名认证冻结 9：普通冻结及未实名认证冻结 10：公安冻结及未实名认证冻结 表6 PageInfo 参数 参数类型 描述 next_marker String 返回下一页的查询地址 previous_marker String 返回前一页查询地址 current_count Integer 本页返回条目数量 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 请求已成功。 { "keypairs" : [ { "keypair" : { "name" : "1hprr3TI", "type" : "ssh", "scope" : "user", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABjV8GvwpSs.....", "fingerprint" : "65:ca:87:0a:16:86:59:ea:57:ea:18:37:58:e2:04:b0", "is_key_protection" : false, "frozen_state" : 0 } } ]} 状态码： 400 Error response。 { "error_code" : "KPS.XXX", "error_msg" : "XXX"}

响应示例 状态码： 200 请求已成功 { "key_info" : { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "domain_id" : "00074811d5c27c4f8d48bb91e4a1dcfd", "key_alias" : "test", "realm" : "test", "key_description" : "key_description", "creation_date" : "1502799822000", "scheduled_deletion_date" : "", "key_spec" : "AES_256", "key_usage" : "ENCRYPT_DECRYPT", "key_state" : "2", "default_key_flag" : "0", "key_type" : "1", "expiration_time" : "1501578672000", "origin" : "kms", "key_rotation_enabled" : "false", "sys_enterprise_project_id" : "0", "partition_type" : "1" }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_id 是 String 密钥ID，36字节，满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_info KeyDetails object 密钥详情。 表5 KeyDetails 参数 参数类型 描述 key_id String 密钥ID。 domain_id String 用户域ID。 key_alias String 密钥别名。 realm String 密钥区域。 key_spec String 密钥生成算法。 AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 key_usage String 密钥用途。 ENCRYPT_DECRYPT SIGN_VERIFY key_description String 密钥描述。 creation_date String 密钥创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 scheduled_deletion_date String 密钥计划删除时间，时间戳，即从1970年1月1日至该时间的总秒数。 key_state String 密钥状态，满足正则匹配“^[1-5]{1}$”，枚举如下： “1”表示待激活状态 “2”表示启用状态 “3”表示禁用状态 “4”表示计划删除状态 “5”表示等待导入状态 default_key_flag String 默认主密钥标识，默认主密钥标识为1，非默认标识为0。 key_type String 密钥类型。 expiration_time String 密钥材料失效时间，时间戳，即从1970年1月1日至该时间的总秒数。 origin String 密钥来源，默认为“kms”，枚举如下： kms表示密钥材料由kms生成kms表示密钥材料由kms生成 external表示密钥材料由外部导入 key_rotation_enabled String 密钥轮换状态，默认为“false”，表示关闭密钥轮换功能。 sys_enterprise_project_id String 企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 keystore_id String 密钥库ID key_label String 密钥在加密机中的标签 partition_type String 分区类型，枚举如下： 1为专业版 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应示例 状态码： 200 OK。 { "task_id" : "aee8d2fe-5484-4753-9177-5a38dc15546c", "task_status" : "RUNNING_RESET", "server_id" : "c9aa197b-a6b6-4c33-b3a6-fa0b4ec50006"} 状态码： 400 Error response。 { "error_code" : "KPS.XXX", "error_msg" : "XXX"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 server_id String 租户虚拟机ID。 task_id String 任务下发成功返回的ID。 task_status String 密钥对正在处理的状态。 READY_RESET 准备重置 RUNNING_RESET 正在重置 FAILED_RESET 重置失败 SUCCESS_RESET 重置成功 READY_REPLACE 准备替换 RUNNING_REPLACE 正在替换 FAILED_RESET 替换失败 SUCCESS_RESET 替换成功 READY_UNBIND 准备解绑 RUNNING_UNBIND 正在解绑 FAILED_UNBIND 解绑失败 SUCCESS_UNBIND 解绑成功 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误描述。