Key Management Service (KMS) は、インスタンスを作成するための API 操作を提供していません。代わりに、Alibaba Cloud 課金管理 API の CreateInstance 操作を呼び出して KMS インスタンスを作成できます。
背景情報
Alibaba Cloud 課金管理 API は、Alibaba Cloud リソースを管理するための一連の共通 API 操作です。これらの操作を使用して、サービスの価格のクエリ、インスタンスの管理、課金情報の取得ができます。サポートされているすべての API 操作の詳細については、「API 概要」をご参照ください。
Alibaba Cloud 課金管理 API のインスタンス作成サービス操作を呼び出して、KMS インスタンスを作成できます。この操作の呼び出し方法の詳細については、「署名メカニズム」をご参照ください。
デバッグ
OpenAPI Explorer でこの操作を直接実行すると、署名計算を簡略化できます。正常に実行されると、OpenAPI Explorer は自動的に SDK のコード例を生成します。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 | 値の例 |
ProductCode | string | はい | プロダクトコードです。値を kms に設定して Key Management Service を指定します。 | 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 番目のモジュールプロパティの値です。n の値の範囲は 1~100 です。 | cn-shanghai |
└Code | string | はい | N 番目のモジュールプロパティのコードです。n の値の範囲は 1~100 です。複数のモジュールプロパティが存在する場合、n=1,2,3,... のように連結します。 | Region |
パラメーター設定
名前 | タイプ | 必須 | 値の例 | 説明 |
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 | 有効な値の詳細については、Key Management Service 購入ページをご参照ください。 |
Parameter.4.Code | String | はい | KeyNum | KMS インスタンスのキーのクォータです。 |
Parameter.4.Value | String | はい | 1000 | 有効な値の詳細については、Key Management Service 購入ページをご参照ください。 |
Parameter.5.Code | String | はい | SecretNum | KMS インスタンスのシークレットのクォータです。 |
Parameter.5.Value | String | はい | 1000 | 有効な値の詳細については、Key Management Service 購入ページをご参照ください。 |
Parameter.6.Code | String | はい | VpcNum | KMS インスタンスのアクセス管理クォータです。 |
Parameter.6.Value | String | はい | 10 | 有効な値の詳細については、Key Management Service 購入ページをご参照ください。 |
Parameter.7.Code | String | はい | log | KMS インスタンスのログ機能を有効にするかどうかを指定します。 |
Parameter.7.Value | String | はい | 1 | 有効な値:
|
Parameter.8.Code | String | いいえ | logStore | ログストレージ容量 (GB) です。 説明 このパラメーターは、ログ機能を有効にするときに必須です。 |
Parameter.8.Value | String | いいえ | 1000 | 有効な値の詳細については、Key Management Service 購入ページをご参照ください。 |
応答パラメーター
名前 | タイプ | 値の例 | 説明 |
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
}