すべてのプロダクト
Search

このプロダクト

    Key Management Service:CreateInstance

    ドキュメントセンター

    Key Management Service:CreateInstance

    最終更新日:Dec 18, 2024

    Key Management Service (KMS) では、KMSインスタンスを作成する操作は提供されません。 KMSインスタンスを作成するには、トランザクションおよび請求書管理APIのCreateInstance操作を呼び出します。 このAPIは略してBSS APIと呼ばれます。

    背景情報

    BSS APIは、Alibaba Cloudリソースの管理に使用される一連の一般的な操作です。 たとえば、操作を呼び出して、サービス料金の照会、インスタンスの管理、請求書の取得を行うことができます。 BSS APIの操作の詳細については、「関数別の操作のリスト」をご参照ください。

    BSS APIによって提供されるCreateInstance操作を呼び出して、KMSインスタンスを作成できます。 操作の呼び出し方法の詳細については、「リクエスト構文と署名メソッドV3」をご参照ください。

    デバッグ

    OpenAPI Explorer は署名値を自動的に計算します。 利便性を考慮して、この操作は OpenAPI Explorer で呼び出すことが推奨されます。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    ProductCode

    String

    対象

    サービスのコード。 値をkmsを示すKMSに設定します。

    kms

    ProductType

    String

    非対象

    サービスタイプです。 有効な値：

    • kms_ddi_public_cn: 中国サイト (aliyun.com)

    • kms_ddi_public_intl: 国際サイト (alibabacloud.com)

    kms_ddi_public_cn

    SubscriptionType

    String

    対象

    課金方法です。 有効な値：

    • サブスクリプション

    • PayAsYouGo

    サブスクリプション

    Period

    integer

    非対象

    サブスクリプション期間です。 単位：月。 年ごとにサービスに加入する場合は、12の整数倍を入力します。

    説明

    このパラメーターは、SubscriptionTypeをSubscriptionに設定する場合に必要です。

    12

    RenewalStatus

    String

    非対象

    更新モードです。 有効な値：

    • 自動更新

    • ManualRenewal (デフォルト)

    ManualRenewal

    更新期間

    integer

    非対象

    自動更新の期間です。 単位：月。

    説明

    このパラメーターは、RenewalStatusをAutoRenewalに設定した場合に必要です。

    12

    ClientToken

    String

    非対象

    リクエストのべき等性を保証するために使用されるクライアントトークン。 サーバーは、同じクライアントトークンを使用する要求が受信されたかどうかをチェックします。 同じクライアントトークンを使用するリクエストを受信した場合、サーバーは前のリクエストと同じリクエスト結果を返します。

    JASIOFKVNVIXXXXXX

    パラメーター

    object []

    非対象

    モジュール。

    └Value

    String

    対象

    KMSインスタンスに設定されたN番目の属性の値。 N: 1 ~ 100の有効値。

    リージョン

    └Code

    String

    対象

    KMSインスタンスに設定されたN番目の属性のコード。 N: 1 ~ 100の有効値。 複数の属性を設定する場合は、昇順で属性を連結します。

    cn-shanghai

    パラメーター設定

    パラメーター

    型

    必須 / 任意

    例

    説明

    Parameter.1.Code

    String

    対象

    ProductVersion

    KMSインスタンスのタイプ。

    Parameter.1.Value

    String

    対象

    3

    有効な値：

    • 1: ハードウェアキー管理タイプのKMSインスタンス

    • 3: ソフトウェアキー管理タイプのKMSインスタンス

    Parameter.2.Code

    String

    対象

    リージョン

    KMSインスタンスのリージョン。

    Parameter.2.Value

    String

    対象

    cn-shanghai

    DescribeRegions を呼び出して、最新のリージョンリストをクエリできます。

    Parameter.3.Code

    String

    対象

    Spec

    KMSインスタンスのパフォーマンスデータ。

    パラメータ3.Value

    String

    対象

    1000

    KMS購入ページに移動して、有効な値を表示できます。

    Parameter.4.Code

    String

    対象

    KeyNum

    KMSインスタンスのキークォータ。

    Parameter.4.Value

    String

    対象

    1000

    KMS購入ページに移動して、有効な値を表示できます。

    Parameter.5.Code

    String

    対象

    SecretNum

    KMSインスタンスのシークレットクォータ。

    Parameter.5.Value

    String

    対象

    1000

    KMS購入ページに移動して、有効な値を表示できます。

    Parameter.6.Code

    String

    対象

    VpcNum

    KMSインスタンスのアクセス管理クォータ。

    パラメーター6.Value

    String

    対象

    10

    KMS購入ページに移動して、有効な値を表示できます。

    Parameter.7.Code

    String

    対象

    log

    KMSインスタンスのSimple Log Service for KMS機能を有効にするかどうかを指定します。

    Parameter.7.Value

    String

    対象

    1

    有効な値：

    • 0: いいえ

    • 1: はい

    Parameter.8.Code

    String

    任意

    logStore

    ログ容量。 (単位：GB)

    説明

    このパラメーターは、Simple Log Service for KMS機能を有効にする場合に必要です。

    Parameter.8.Value

    String

    任意

    1000

    KMS購入ページに移動して、有効な値を表示できます。

    レスポンスパラメーター

    パラメーター

    タイプ

    例

    説明

    Code

    String

    Success

    ステータスコード。

    Data

    Struct

    返された情報。

    [ホストID]

    String

    testId

    ホストの ID。

    OrderId

    String

    23646261542 ****

    注文 ID。

    Message

    String

    成功!

    Codeに対して返されたメッセージ。

    RequestId

    String

    24CC6FF3-7A78-5CF9-A3FF-74A630EBFAD9

    リクエスト ID。

    Success

    Boolean

    true

    呼び出しが成功したかどうかを示します。 有効な値：

    • true

    • false

    例

    成功レスポンスの例

    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
}