从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

{
  "getKmsServerCertFromKms": {},
  "systemTags": [],
  "userTags": []
}

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

Curl示例

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X PUT -d '{"getKmsServerCertFromKms":{}}' \
http://localhost:8080/zstack/v1/key-providers/kms/ff0a9250e11b3fe5a553d61be176d300/actions

参数列表

名字	类型	位置	描述	起始版本
uuid	String	url	资源的UUID，唯一标示该资源	5.0.0
systemTags (可选)	List	body	系统标签	5.0.0
userTags (可选)	List	body	用户标签	5.0.0

API返回

返回示例

{
  "serverCertPem": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "selfSigned": true,
  "serverCertInfo": {
    "subject": "CN=kms.example.com,O=zstack",
    "issuer": "CN=zstack-ca,O=zstack",
    "commonName": "kms.example.com",
    "subjectAltNamesDns": [
      "kms.example.com"
    ],
    "subjectAltNamesIp": [
      "127.0.0.1"
    ],
    "expiredDate": "Nov 14, 2017 2:20:57 PM"
  }
}

名字	类型	描述	起始版本
serverCertPem	String	服务端证书	5.0.0
selfSigned	boolean	服务端证书是否为自签证书	5.0.0
serverCertInfo	CertificateInfo	服务端证书解析信息	5.0.0
success	boolean		5.0.0
error	ErrorCode	详情参考error	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

GetKmsServerCertFromKmsAction action = new GetKmsServerCertFromKmsAction();
action.uuid = "ff0a9250e11b3fe5a553d61be176d300";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetKmsServerCertFromKmsAction.Result res = action.call();

Python SDK

action = GetKmsServerCertFromKmsAction()
action.uuid = "ff0a9250e11b3fe5a553d61be176d300"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()