华为云用户手册

请求示例 创建事件。 { "name" : "demo-event", "event_types" : [ "SECRET_VERSION_CREATED", "SECRET_VERSION_EXPIRED" ], "state" : "ENABLED", "notification" : { "target_type" : " SMN ", "target_id" : "urn:smn:cn-north-4:dc3b7c85759141a991da17423c0f2068:test-poc", "target_name" : "demo-smn-name" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 新创建事件通知的名称。 约束：取值范围为1到64个字符，满足正则匹配“^[a-zA-Z0-9_-]{1,64}$”。 event_types 是 Array of strings 本次事件通知的基础事件列表，基础事件类型如下。 SECRET_VERSION_CREATED：版本创建 SECRET_VERSION_EXPIRED：版本过期 SECRET_ROTATED：凭据轮转 SECRET_DELETED：凭据删除 SECRET_ROTATED_FAILED:凭据轮转失败 列表包含的基础事件类型不能重复。 state 是 String 控制事件是否生效，只有启用状态才能触发包含的基础事件类型 ENABLED：启用 DISABLED：禁用 notification 是 Notification object 通知主题对象。 表4 Notification 参数 是否必选 参数类型 描述 target_type 是 String 事件通知的对象类型。 target_id 是 String 事件通知的对象ID。 target_name 是 String 事件通知的对象名称。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 event Event object 事件通知对象。 表6 Event 参数 参数类型 描述 name String 事件通知名称。 event_id String 事件通知的资源标识符。 event_types Array of strings 设置事件的基础事件类型列表,。 约束：数组大小：最小1，最大12。 state String 事件通知状态，取值如下。 ENABLED：表示启用状态 DISABLED：表示禁用状态 create_time Long 事件通知创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 update_time Long 事件通知上次更新时间，时间戳，即从1970年1月1日至该时间的总秒数。 notification Notification object 通知主题对象。 表7 Notification 参数 参数类型 描述 target_type String 事件通知的对象类型。 target_id String 事件通知的对象ID。 target_name String 事件通知的对象名称。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表12 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表16 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表18 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表20 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表21 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 keypair ExportPrivateKeyKeypairBean object 导出的私钥信息。 表6 ExportPrivateKeyKeypairBean 参数 参数类型 描述 name String SSH密钥对的名称。 private_key String SSH密钥对的私钥 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 请求已成功 { "keypair" : { "name" : "demo2", "private_key" : "-----BEGIN RSA PRIVATE KEY-----..." } } 状态码： 400 Error response { "error_code" : "KPS.XXX", "error_msg" : "XXX" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 keypair 是 KeypairBean object 待导出私钥的的密钥对信息。 表4 KeypairBean 参数 是否必选 参数类型 描述 name 是 String SSH密钥对名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 version_metadata VersionMetadata object 凭据版本被标记的状态。 表5 VersionMetadata 参数 参数类型 描述 id String 凭据的版本号标识符，凭据对象下唯一。 create_time Long 凭据版本创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 expire_time Long 凭据版本过期时间，时间戳，即从1970年1月1日至该时间的总秒数。默认为空，凭据订阅“版本过期”事件类型时，有效期判断所依据的值。 kms_key_id String 加密版本凭据值的KMS主密钥ID。 secret_name String 凭据名称。 version_stages Array of strings 凭据版本被标记的状态列表。每个版本标签对于凭据对象下版本是唯一存在的，如果创建版本时，指定的是同一凭据对象下的一个已经标记在其他版本上的状态，该标签将自动从其他版本上删除，并附加到此版本上。 如果未指定version_stage的值，则凭据管理服务会自动移动临时标签SYSCURRENT到此新版本。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 502 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 504 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 请求已成功 { "version_metadata" : { "id" : "v3", "kms_key_id" : "b168fe00ff56492495a7d22974df2d0b", "create_time" : 1581507580000, "secret_name" : "secret-name-demo", "version_stages" : [ "SYSCURRENT" ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 expire_time 是 Long 凭据版本过期时间，时间戳，即从1970年1月1日至该时间的总秒数。默认为空，凭据订阅“版本过期”事件类型时，有效期判断所依据的值。

请求示例 签名消息信息，使用ID为"0d0466b0-e727-4d9c-b35d-f84bb474a37f"的密钥，采用"RSASSA_PK CS 1_V1_5_SHA_256"签名算法，对摘要消息进行签名。 { "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f", "signing_algorithm" : "RSASSA_PKCS1_V1_5_SHA_256", "message" : "MmFiZWE0ZjI3ZGIxYTkzY2RmYmEzM2YwMTA1YmJjYw==" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_id String 密钥ID。 signature String 签名值，使用base64编码。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表6 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表8 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表10 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表12 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表13 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表14 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表15 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表16 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表17 响应Body参数 参数 参数类型 描述 error Object 错误信息返回体。 表18 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-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$”。 例如：0d0466b0-e727-4d9c-b35d-f84bb474a37f。 message 是 String 待签名的消息摘要或者消息，消息长度要求小于4096字节，使用Base64编码。 signing_algorithm 是 String 签名算法，枚举如下： RSASSA_PSS_SHA_256 RSASSA_PSS_SHA_384 RSASSA_PSS_SHA_512 RSASSA_PKCS1_V1_5_SHA_256 RSASSA_PKCS1_V1_5_SHA_384 RSASSA_PKCS1_V1_5_SHA_512 ECDSA_SHA_256 ECDSA_SHA_384 ECDSA_SHA_512 SM2DSA_SM3 message_type 否 String 消息类型，默认为“DIGEST”，枚举如下： DIGEST 表示消息摘要 RAW 表示消息原文 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff。

响应消息 表3 响应参数 参数 是否必选 参数类型 描述 changed 是 Integer 复制的密钥对数量。 success 是 Array of objects 复制成功的密钥对列表，详情请参见表4。 failed 是 Array of objects 复制失败的密钥对列表，详情请参见表4。 表4 success/failed字段数据结构说明 参数 是否必选 参数类型 描述 keypair 是 String 密钥对名称。 message 是 String 任务消息

响应示例 状态码： 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" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 limit 否 String 查询记录数（“action”为“count”时，无需设置此参数），如果“action”为“filter”，默认为“10”。 limit的取值范围为“1-1000”。 offset 否 String 索引位置。从offset指定的下一条数据开始查询。查询第一页数据时，将查询前一页数据时响应体中的值带入此参数（“action”为“count”时，无需设置此参数）。如果“action”为“filter”，offset默认为“0”。 offset必须为数字，不能为负数。 action 是 String 操作标识（可设置为“filter”或者“count”）。 filter：表示过滤。 count：表示查询总条数。 tags 否 Array of Tag objects 标签列表，key和value键值对的集合。最多不超过10个。 matches 否 Array of TagMatches objects 搜索字段。 key为搜索的字段，目前仅支持搜索凭据名称，值为“resource_name”。 value为模糊匹配的值，最大长度为255个字符。为空返回空值。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff 表4 Tag 参数 是否必选 参数类型 描述 key 否 String 标签键。 values 否 Array of strings 标签值集合。 约束：最多包含10个value。标签列表中的标签value值不允许重复。标签列表如果为空列表，表示匹配任意值。标签列表中多个value之间是“或”的关系，在key已经满足要求的前提下，满足请求中的某个value就会匹配出来。 表5 TagMatches 参数 是否必选 参数类型 描述 key 否 String 为要匹配的字段。 约束：值只能为resource_name。 value 否 String 模糊匹配的值。 约束：最大长度为255个字符，为空返回空值。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户来进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见企业管理应用场景。

概述 欢迎使用 数据加密 服务（Data Encryption Workshop，DEW）。数据加密服务是一个综合的云上数据加密服务。它可以提供专属加密、密钥管理、凭据管理、密钥对管理等服务，安全可靠地为用户解决了数据安全、密钥安全、密钥管理复杂等问题。其密钥由硬件安全模块（Hardware Security Module，HSM） 保护，并与多个华为云服务集成。您也可以借此服务开发自己的加密应用。 在调用数据加密服务API之前，请确保已经充分了解数据加密服务相关概念，详细信息请参见产品介绍。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 key_info KeKInfo object 密钥详细信息。 表5 KeKInfo 参数 参数类型 描述 key_id String 密钥ID。 domain_id String 用户域ID。 状态码： 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 错误请求返回的错误信息

接口约束 别名“/default”为服务默认主密钥的后缀名，由服务自动创建。因此用户创建的主密钥别名不能与服务默认主密钥的别名相同，即后缀名不能为“/default”。 对于开通企业项目的用户，服务默认主密钥属于且只能属于默认企业项目下，且不支持企业资源的迁入迁出。服务默认主密钥为用户提供基础的云上加密功能，满足合规要求。因此，在企业多项目下，其他非默认企业项目下的用户均可使用该密钥。若客户有企业管理资源诉求，请自行创建和使用密钥。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 key_alias 是 String 非默认主密钥别名，取值范围为1到255个字符，满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”，且不与系统服务创建的默认主密钥别名重名。 key_spec 否 String 密钥生成算法，默认为“AES_256”，枚举如下： AES_256 SM4 RSA_2048 RSA_3072 RSA_4096 EC_P256 EC_P384 SM2 key_usage 否 String 密钥用途，对称密钥默认为“ENCRYPT_DECRYPT”，非对称密钥默认为“SIGN_VERIFY”，枚举如下： ENCRYPT_DECRYPT SIGN_VERIFY key_description 否 String 密钥描述，取值0到255字符。 origin 否 String 密钥来源，默认为“kms”，枚举如下： kms：表示密钥材料由kms生成。 external：表示密钥材料由外部导入。 enterprise_project_id 否 String 企业多项目ID。 用户未开通企业多项目时，不需要输入该字段。 用户开通企业多项目时，创建资源可以输入该字段。若用户户不输入该字段，默认创建属于默认企业多项目ID（ID为“0”）的资源。 注意：若用户没有默认企业多项目ID（ID为“0”）下的创建权限，则接口报错。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff keystore_id 否 String 密钥库ID，默认使用KMS默认密钥库

响应示例 状态码： 200 请求已成功 { "records" : [ { "event_name" : "demo-event", "trigger_event_type" : "SECRET_VERSION_EXPIRED", "create_time" : 1581507580000, "secret_name" : "demo-secret", "secret_type" : "COMMON", "notification_target_name" : "SecertExpirationNotificationTest", "notification_target_id" : "urn:smn:cn-north-4:SecertExpirationTest", "notification_content" : "{\"eventName\":\"TestEvent20221112\",\"eventType\":\"SECRET_VERSION_EXPIRED\",\"eventTime\":\"2023-04-14T20:25:10.126Z\",\"data\":{\"secretId\":\"fde3d6ba-cb31-40b0-b6c4-78757050f8c8\",\"secretName\":\"Secret20230325\",\"createTime\":\"2023-03-22T20:43:04.000Z\",\"updateTime\":\"2023-04-14T20:18:29.000Z\",\"versionId\":\"v18\",\"versionExpireTime\":\"2023-03-29T17:07:23.000Z\"}}", "notification_status" : "SUC CES S" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 records Array of Record objects Record对象。 page_info PageInfo object 分页信息。 表4 Record 参数 参数类型 描述 event_name String 凭据名称。 trigger_event_type String 事件类型。 SECRET_VERSION_CREATED:版本创建 SECRET_VERSION_EXPIRED:版本过期 SECRET_ROTATED:凭据轮转成功 SECRET_DELETED:凭据删除 SECRET_ROTATED_FAILED:凭据轮转失败 create_time Long 事件通知记录的创建时间，时间戳，即从1970年1月1日至该时间的总秒数。 secret_name String 凭据名称。 secret_type String 凭据类型 COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存。 RDS：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。（已不支持，使用RDS-FG替代） RDS-FG：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。 GaussDB -FG：GaussDB凭据。专门针对GaussDB的凭据，用于存储GaussDB的账号信息。 notification_target_name String 事件通知的对象名称。 notification_target_id String 事件通知的对象ID。 notification_content String 事件通知的内容。 notification_status String 事件通知状态。 SUCCESS：事件通知成功。 FAIL：事件通知失败。 INVALID：事件通知配置主题信息无效或不正确，无法触发通知。 表5 PageInfo 参数 参数类型 描述 next_marker String 下一页查询地址（本页的末尾凭据名称，下一页起始凭据名称）。 previous_marker String 本页的起始凭据名称，上一页末尾凭据名称。 current_count Integer 本页返回条目数量。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表7 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表9 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表11 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表13 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 500 表14 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表15 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 502 表16 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表17 ErrorDetail 参数 参数类型 描述 error_code String 错误请求返回的错误码 error_msg String 错误请求返回的错误信息 状态码： 504 表18 响应Body参数 参数 参数类型 描述 error ErrorDetail object 错误信息返回体。 表19 ErrorDetail 参数 参数类型 描述 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 表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。 secret_type String 凭据类型 COMMON：通用凭据(默认)。用于应用系统中的各种敏感信息储存。 RDS：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。（已不支持，使用RDS-FG替代） RDS-FG：RDS凭据 。专门针对RDS的凭据，用于存储RDS的账号信息。 GaussDB-FG：GaussDB凭据。专门针对GaussDB的凭据，用于存储GaussDB的账号信息。 auto_rotation Boolean 自动轮转 取值：true 开启, false 关闭(默认) rotation_period String 轮转周期 约束：6小时-8,760小时 （365天） 类型：Integer[unit] ，Integer表示时间长度 。unit表示时间单位，d（天）、h（小时）、m（分钟）、s（秒）。例如 1d 表示一天，24h也表示一天 说明：当开启自动轮转时，必须填写该值 rotation_config String 轮转配置 约束：范围不超过1024个字符。 当secret_type为RDS-FG、GaussDB-FG时，配置为{"InstanceId":"","SecretSubType":""} 说明：当secret_type为RDS-FG、GaussDB-FG时，必须填写该值 InstanceId为实例ID,SecretSubType为轮转子类型，取值为：SingleUser，MultiUser。 SingleUser：指定轮转类型为单用户模式轮转，每次轮转将指定账号重置为新的口令。 MultiUser：指定轮转类型为双用户模式轮转，SYSCURRENT和SYSPREVIOUS分别引用其中一个账号。凭据轮转时，SYSPREVIOUS引用的账号口令会被重置为新的随机口令，随后凭据交换SYSCURRENT和SYSPREVIOUS对账号的引用。 rotation_time Long 轮转时间戳 next_rotation_time Long 下一次轮转时间戳 event_subscriptions Array of strings 凭据订阅的事件列表，当前最大可订阅一个事件。当事件包含的基础事件触发时，通知消息将发送到事件对应的通知主题。 enterprise_project_id String 企业项目ID rotation_func_urn String FunctionGraph函数的urn。 状态码： 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 表4 响应Body参数 参数 参数类型 描述 key_info KeyStatusInfo object 密钥状态信息。 表5 KeyStatusInfo 参数 参数类型 描述 key_id String 密钥ID key_state String 密钥状态： 2为启用状态 3为禁用状态 4为计划删除状态 5为等待导入状态 7为冻结状态 状态码： 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。 sequence 否 String 请求消息序列号，36字节序列号。 例如：919c82d4-8046-4722-9094-35c3c6524cff

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于管理员创建IAM用户接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "user": { "id": "c131886aec...", "name": "IAMUser", "description": "IAM User Description", "areacode": "", "phone": "", "email": "***@***.com", "status": null, "enabled": true, "pwd_status": false, "access_mode": "default", "is_domain_owner": false, "xuser_id": "", "xuser_type": "", "password_expires_at": null, "create_time": "2024-05-21T09:03:41.000000", "domain_id": "d78cbac1..........", "xdomain_id": "30086000........", "xdomain_type": "", "default_project_id": null } } 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "Request body is invalid.", "error_code": "IAM.0011" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应示例 状态码： 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 表4 响应Body参数 参数 参数类型 描述 total Integer 正在处理的任务总数。 tasks Array of RunningTasks objects 正在处理的任务列表。 表5 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 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求消息 创建SSH密钥对时，只需要提交SSH密钥对的name属性。导入SSH密钥对时，才需要提交public_key属性。 表2 请求参数 参数 是否必选 参数类型 描述 keypair 是 Object 创建或导入的SSH密钥对的信息，详情请参见表3。 表3 keypair字段数据结构说明 参数 是否必选 参数类型 描述 public_key 否 String 导入公钥的字符串信息。 name 是 String SSH密钥对的名称。 新创建的密钥对名称不能和已有密钥对的名称相同。 SSH密钥对名称由英文字母、数字、下划线、中划线组成，长度不能超过64个字节。 user_id 否 String SSH密钥对的用户ID。 key_protection 否 Object SSH密钥对私钥托管与保护，详情请参见表4。