Upload a KMS Client Certificate and Private Key

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": []
}

In the preceding example, the systemTags and userTags fields can be omitted. They are listed to indicate that the body can include these two fields.

Curl Example

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

Parameter List

Name	Type	Location	Description	Optional Value	Since
identityType	String	body (contained in `uploadKmsClientIdentity` structure)	Identity source type	UPLOADED PLATFORM	5.0.0
kmsClientCertPem	String	body (contained in `uploadKmsClientIdentity` structure)	Client certificate		5.0.0
kmsClientKeyPem	String	body (contained in `uploadKmsClientIdentity` structure)	Client private key		5.0.0
uuid	String	url	Resource UUID, which uniquely identifies the resource		5.0.0
systemTags (optional)	List	body	System tags		5.0.0
userTags (optional)	List	body	User tags		5.0.0

API Response

Response Example

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

Name	Type	Description	Since
success	boolean		5.0.0
inventory	KmsIdentityInventory	For details, see inventory	5.0.0
error	ErrorCode	For details, see error	5.0.0

inventory

Name	Type	Description	Since
uuid	String	Resource UUID, which uniquely identifies the resource	5.0.0
kmsUuid	String	KmsUUID	5.0.0
identityType	String	Identity type	5.0.0
clientCertPem	String	KMSClient certificate	5.0.0
csrPem	String	CSR content	5.0.0
certExpiredDate	Timestamp	Client certificate expiration time	5.0.0
createDate	Timestamp	Creation time	5.0.0
lastOpDate	Timestamp	Last modification time	5.0.0

error

Name	Type	Description	Since
code	String	Error code, which is the globally unique identifier of the error, for example, SYS.1000 or HOST.1001	0.6
description	String	Summary description of the error	0.6
details	String	Detailed information about the error	0.6
elaboration	String	Reserved field. The default value is null.	0.6
opaque	LinkedHashMap	Reserved field. The default value is null.	0.6
cause	ErrorCode	Root error that caused the current error. If no root error exists, this field is null.	0.6

SDK Example

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()