上传KMS客户端证书与私钥

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

Request

cURL

curl --request PUT \
  --url '/v1/key-providers/kms/{uuid}/actions' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "PUT",
  "path": "/v1/key-providers/kms/{uuid}/actions"
}

Headers

Authorization: OAuth the-session-uuid

Body

{
  "uploadKmsClientIdentity": {
    "identityType": "UPLOADED",
    "kmsClientCertPem": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
    "kmsClientKeyPem": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
  },
  "systemTags": [],
  "userTags": []
}

上述示例中systemTags、userTags字段可以省略。列出是为了表示body中可以包含这两个字段。

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"uploadKmsClientIdentity":{"identityType":"UPLOADED","kmsClientCertPem":"-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----","kmsClientKeyPem":"-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"}}' \
http://localhost:8080/zstack/v1/key-providers/kms/ff0a9250e11b3fe5a553d61be176d300/actions

参数列表

名字	类型	位置	描述	可选值	起始版本
identityType	String	body(包含在`uploadKmsClientIdentity`结构中)	身份来源类型	UPLOADED PLATFORM	5.0.0
kmsClientCertPem	String	body(包含在`uploadKmsClientIdentity`结构中)	客户端证书		5.0.0
kmsClientKeyPem	String	body(包含在`uploadKmsClientIdentity`结构中)	客户端私钥		5.0.0
uuid	String	url	资源的UUID，唯一标示该资源		5.0.0
systemTags (可选)	List	body	系统标签		5.0.0
userTags (可选)	List	body	用户标签		5.0.0

API返回

返回示例

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

名字	类型	描述	起始版本
success	boolean		5.0.0
inventory	KmsIdentityInventory	详情参考inventory	5.0.0
error	ErrorCode	详情参考error	5.0.0

inventory

名字	类型	描述	起始版本
uuid	String	资源的UUID，唯一标示该资源	5.0.0
kmsUuid	String	KmsUUID	5.0.0
identityType	String	身份类型	5.0.0
clientCertPem	String	KMS客户端证书	5.0.0
csrPem	String	CSR内容	5.0.0
certExpiredDate	Timestamp	客户端证书到期时间	5.0.0
createDate	Timestamp	创建时间	5.0.0
lastOpDate	Timestamp	最后一次修改时间	5.0.0

error

名字	类型	描述	起始版本
code	String	错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001	0.6
description	String	错误的概要描述	0.6
details	String	错误的详细信息	0.6
elaboration	String	保留字段，默认为null	0.6
opaque	LinkedHashMap	保留字段，默认为null	0.6
cause	ErrorCode	根错误，引发当前错误的源错误，若无原错误，该字段为null	0.6

SDK示例

Java SDK

UploadKmsClientIdentityAction action = new UploadKmsClientIdentityAction();
action.uuid = "ff0a9250e11b3fe5a553d61be176d300";
action.identityType = "UPLOADED";
action.kmsClientCertPem = "-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----";
action.kmsClientKeyPem = "-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
UploadKmsClientIdentityAction.Result res = action.call();

Python SDK

action = UploadKmsClientIdentityAction()
action.uuid = "ff0a9250e11b3fe5a553d61be176d300"
action.identityType = "UPLOADED"
action.kmsClientCertPem = "-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----"
action.kmsClientKeyPem = "-----BEGIN PRIVATE KEY-----
...
-----END PRIVATE KEY-----"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()