この API を呼び出して、ApsaraDB for PolarDB クラスターを作成できます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、各種 SDK 用のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
DBNodeClass String 必須 polar.mysql.x2.medium

ノードの仕様を設定します。 詳細については、「仕様と料金」をご参照ください。

DBType String 必須 MySQL

データベースのエンジンを設定します。 設定可能な値は以下のとおりです。

  • MySQL
  • PostgreSQL
  • Oracle
DBVersion String 必須 5.6

データベースエンジンのバージョンを設定します。 設定可能な値は以下のとおりです。

  • MySQL：5.6 または 8.0
  • PostgreSQL：11
  • Oracle：11
PayType String 必須 Postpaid

クラスターの課金方法を設定します。 設定可能な値は以下のとおりです。

  • Postpaid：従量課金
  • Prepaid：サブスクリプション
RegionId String 必須 ch-hangzhou

リージョンの ID を設定します。 文字長は 50 文字以内とする必要があります。

注 DescribeRegions を呼び出して、最新のリージョンリストを照会できます。
AccessKeyId String 任意 key-test

Alibaba Cloud から提供された AccessKey ID を設定します。
Action String 任意 CreateDBCluster

実行する API ( CreateDBCluster) を設定します。

AutoRenew Boolean 任意 true

自動更新を有効にするかどうかを設定します。 設定可能な値は以下のとおりです。

  • true：有効にする
  • false：無効にする

デフォルト値：false

注 このパラメーターは、PayType パラメーターが Prepaid に設定された場合のみ有効です。
ClientToken String 任意 6000170000591aed949d0f54a343f1a4233c1e7d1c5ca816be

リクエストのべき等性を保証するために使用されるクライアントトークンを設定します。 クライアントを使用してこの値を生成できますが、異なるリクエスト間で一意である必要があります。 トークンでは大文字と小文字が区別されます。 トークンには ASCII 文字のみを含めることができ、文字長は 64 文字を超えることはできません。

CloneDataPoint String 任意 LATEST

複製するデータの時点を設定します。 設定可能な値は以下のとおりです。

  • LATEST：最新のデータを複製します。
  • BackupID：バックアップデータの履歴から複製します。 特定のバックアップセットの ID を指定します。

  • Timestamp：過去の時点のデータを複製します。 特定の時点をyyyy-MM-ddTHH:mm:ssZ (UTC) の形式で指定します。

    デフォルト値：LATEST

注
  • このパラメーターは、DBType パラメーターが MySQL に設定されている場合、DBVersion パラメーターが 5.6 に設定されている場合、また CreationOption パラメーターが CloneFromRDS または CloneFromPolarDB に設定されている場合にのみ有効です。
  • CreationOption パラメーターが CloneFromRDS に設定されている場合、このパラメーターの値は LATEST とする必要があります。
ClusterNetworkType String 任意 VPC

VPC のみサポートされます。
CreationOption String 任意 Normal

ApsaraDB for PolarDB クラスターの作成方法を設定します。 設定可能な値は以下のとおりです。

デフォルト値：Normal

注 DBType パラメーターが MySQL に設定されている場合、また DBVersion パラメーターが 5.6 に設定されている場合、このパラメーターは CloneFromRDS または MigrationFromRDS に指定できます。
DBClusterDescription String 任意 MySQL test

クラスター名を設定します。

  • 先頭は文字とする必要があります。
  • 英字、数字、コンマ (,)、ハイフン (-) を使用できます。
  • http:// または https://で開始することはできません。
  • 文字長は 2 文字から 256 文字とする必要があります。
Period String 任意 Month

サブスクリプション期間の単位を設定します。 PayType パラメーターが Prepaid に設定されている場合、このパラメーターは必須です。 設定可能な値は以下のとおりです。

  • Year
  • Month
SourceResourceId String 任意 rm-bp1avd9fwu111****

ソース RDS インスタンスまたはソース PolarDB クラスターの ID を設定します。

注
  • このパラメーターは、DBType パラメーターが MySQL に設定されている場合、また DBVersion パラメーターが 5.6 に設定されている場合にのみ有効です。
  • CreationOption パラメーターが Normal に設定されていない場合、このパラメーターは必須です。
UsedTime String 任意 1
  • Period が Month に設定されている場合、UsedTime は [1-9] にすることができます。
  • Period が Year に設定されている場合、UsedTime は [1-3] にすることができます。
VPCId String 任意 vpc-xxxxxxxxxx

クラスターの VPC ID を設定します。
VSwitchId String 任意 vsw-xxxxxxxxxx

クラスターの VSwitch ID を設定します。
ZoneId String 任意 cn-hangzhou-g

インスタンスのゾーン ID を設定します。

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

レスポンスパラメーター

パラメーター データ型 例 説明
DBClusterId String pc-xxxxxxxxxxxxxxx

クラスターの ID を示します。
OrderId String 20235327xxxxx

注文の ID を示します。
RequestId String E056BF3D-1E4F-4E39-B729-8491A74B301B

リクエストの ID を示します。

コーディング例

リクエストの例


http(s)://[Endpoint]/? Action=CreateDBCluster
&DBNodeClass=polar.mysql.x2.medium
&DBType=MySQL
&DBVersion=5.6
&PayType=Postpaid
&RegionId=cn-hangzhou
&<共通リクエストパラメーター>

正常なレスポンスの例

XML 形式 

<CreateDBClusterResponse>  
      <RequestId>E056BF3D-1E4F-4E39-B729-8491A74B301B</RequestId>
      <OrderId>20235327xxxxx</OrderId>
      <DBClusterId>pc-xxxxxxxxxxxxx</DBClusterId>
</CreateDBClusterResponse>

JSON 形式 

{
	"OrderId":"20235327xxxxx",
	"RequestId":"E056BF3D-1E4F-4E39-B729-8491A74B301B",
	"DBClusterId":"pc-xxxxxxxxxxxxxxx"
}

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。