密鑰管理服務 KMS(Key Management Service)不提供創建實例的接口。您可以通過調用阿里云交易和賬單管理API提供的CreateInstance接口來創建KMS實例。
背景信息
阿里云交易和賬單管理API是一套通用的管理阿里云資源的接口,可以用于查詢服務價格、管理實例、獲取賬單信息等。關于阿里云交易和賬單管理API支持的所有接口,請參見API概覽。
您可以調用阿里云交易和賬單管理API提供的CreateInstance - 實例創建服務接口,創建KMS實例。關于該接口的調用方式,請參見簽名機制說明。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
ProductCode | string | 是 | 產品代碼。設置為kms,表示密鑰管理服務。 | kms |
ProductType | string | 否 | 產品類型。
| kms_ddi_public_cn |
SubscriptionType | string | 是 | 付費類型。
| Subscription |
Period | integer | 否 | 預付費周期。單位為月,按年付費產品請輸入12的整數倍。 說明 當創建預付費實例時,必須設置。 | 12 |
RenewalStatus | string | 否 | 自動續費狀態,取值:
| ManualRenewal |
RenewPeriod | integer | 否 | 自動續費周期, 單位為月。 說明 當設置RenewalStatus為AutoRenewal時,必須設置。 | 12 |
ClientToken | string | 否 | 客戶端冪等參數,服務端會查詢是否有相同 ClientToken 的請求,如果有,直接返回上次調用結果。 | JASIOFKVNVIXXXXXX |
Parameter | object [] | 否 | 模塊列表 | |
└Value | string | 是 | 第 n 個模塊屬性 value 配置,n 的取值范圍為(1~100)。 | Region |
└Code | string | 是 | 第 n 個模塊屬性 code 配置,n 的取值范圍為(1~100),如有多個模塊屬性參數,按照 n=1,2,3…n 的形式拼接多個參數。 | cn-shanghai |
Parameter參數設置
名稱 | 類型 | 是否必選 | 示例值 | 描述 |
Parameter.1.Code | String | 是 | ProductVersion | 表示KMS實例的類型。 |
Parameter.1.Value | String | 是 | 3 | 取值如下:
|
Parameter.2.Code | String | 是 | Region | 表示設置KMS實例的地域。 |
Parameter.2.Value | String | 是 | cn-shanghai | 可通過DescribeRegions接口獲取。 |
Parameter.3.Code | String | 是 | Spec | 表示設置KMS實例的性能數據。 |
Parameter.3.Value | String | 是 | 1000 | 支持的取值,請參見密鑰管理服務售賣頁。 |
Parameter.4.Code | String | 是 | KeyNum | 表示設置KMS實例的密鑰配額。 |
Parameter.4.Value | String | 是 | 1000 | 支持的取值,請參見密鑰管理服務售賣頁。 |
Parameter.5.Code | String | 是 | SecretNum | 表示設置KMS實例的憑據配額。 |
Parameter.5.Value | String | 是 | 1000 | 支持的取值,請參見密鑰管理服務售賣頁。 |
Parameter.6.Code | String | 是 | VpcNum | 表示設置KMS實例的訪問管理數量配額。 |
Parameter.6.Value | String | 是 | 10 | 支持的取值,請參見密鑰管理服務售賣頁。 |
Parameter.7.Code | String | 是 | log | 表示設置KMS實例是否開啟日志。 |
Parameter.7.Value | String | 是 | 1 | 取值:
|
Parameter.8.Code | String | 否 | logStore | 表示日志的容量。單位為GB。 說明 當您開啟日志時,本參數必須設置。 |
Parameter.8.Value | String | 否 | 1000 | 支持的取值,請參見密鑰管理服務售賣頁。 |
返回參數
名稱 | 類型 | 示例值 | 描述 |
Code | String | Success | 本次請求的狀態碼。 |
Data | Struct | 本次請求的返回信息。 | |
└HostId | String | testId | 主機ID。 |
└OrderId | String | 23646261542**** | 創建成功的訂單ID。 |
Message | String | Successful! | Code對應的狀態碼信息。 |
RequestId | String | 24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9 | 本次請求的ID。 |
Success | Boolean | true | 本次請求是否成功。取值:
|
示例
正常返回示例
XML
格式
<CreateInstanceResponse>
<Message>Successful!</Message>
<RequestId>24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9</RequestId>
<Success>true</Success>
<Code>Success</Code>
<Data>
<HostId>testId</HostId>
<OrderId>23646261542****</OrderId>
</Data>
</CreateInstanceResponse>
JSON
格式
{
"Message": "Successful!",
"RequestId": "24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9",
"Data": {
"HostId": "testId",
"OrderId": 23646261542****
},
"Code": "Success",
"Success": true
}