跳转到主要内容
API Explorer|API Explorer
计算管理/虚拟机相关接口/密钥提供程序相关接口
PUTKey Provider APIs起始版本 5.0.0同步需要认证

上传KMS客户端证书与私钥

上传KMS客户端证书与私钥

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

路径参数

请求参数

路径参数

  • uuidString必填

    资源的UUID，唯一标示该资源

请求体字段

  • uploadkmsclientidentityObject必填

    uploadkmsclientidentity 请求体结构

    • identityTypeString必填

      身份来源类型

    • kmsClientCertPemString必填

      客户端证书

    • kmsClientKeyPemString必填

      客户端私钥

  • systemTagsList

    系统标签

  • userTagsList

    用户标签

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • successboolean必填

    操作是否成功。

  • inventoryKmsIdentityInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • kmsUuidString必填

      暂无描述。

    • identityTypeString必填

      身份类型

    • clientCertPemString必填

      KMS客户端证书

    • csrPemString必填

      CSR内容

    • certExpiredDateTimestamp必填

      客户端证书到期时间

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

  • errorErrorCode必填

    详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

请求地址

PUT/zstack/v1/key-providers/kms/{uuid}/actions

/zstack/v1/key-providers/kms/{uuid}/actions

操作 ID

UploadKmsClientIdentity

永久链接

请求示例

curl -X PUT 'http://{host}/zstack/v1/key-providers/kms/{uuid}/actions' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"uploadkmsclientidentity":{"identityType":"<identityType>","kmsClientCertPem":"<kmsClientCertPem>","kmsClientKeyPem":"<kmsClientKeyPem>"},"systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "uuid": "ff0fe4c52fce34ff9ffca4d3a0fd4d00", "kmsUuid": "ff0a9250e11b3fe5a553d61be176d300", "identityType": "CSR", "clientCertPem": "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----", "csrPem": "-----BEGIN CERTIFICATE REQUEST-----\\n...\\n-----END CERTIFICATE REQUEST-----", "certExpiredDate": "Nov 14, 2017 2:20:57 PM", "createDate": "Nov 14, 2017 2:20:57 PM", "lastOpDate": "Nov 14, 2017 2:20:57 PM" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史