建立 PolarDBX Search 執行個體。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
執行個體所在地域。 |
cn-hangzhou |
| PayType |
string |
是 |
執行個體付費類型。
|
PREPAY |
| ZoneId |
string |
是 |
執行個體可用區。 |
cn-beijing-h |
| Zone2 |
string |
否 |
第二可用區。當 TopologyType 為 3azones 時必填，且不能與其他可用區重複。 |
cn-hangzhou-i |
| Zone3 |
string |
否 |
第三可用區。當 TopologyType 為 3azones 時必填，且不能與其他可用區重複。 |
cn-hangzhou-j |
| TopologyType |
string |
否 |
拓撲類型：
|
3azones |
| VPCId |
string |
是 |
VPC ID。 |
vpc-***** |
| VSwitchId |
string |
是 |
虛擬交換器 ID。 |
vsw-********* |
| EngineVersion |
string |
否 |
PolarDBX Search 引擎版本。目前固定為 3.0；未傳送時使用 3.0。 |
3.0 |
| DBNodeClass |
string |
是 |
PolarDBX Search 資料節點規格代碼。可用規格取決於地域和販售設定，請使用目前地域可購買的 PolarDBX Search 規格代碼。 |
opensearch.sn2ne.large.1 |
| NodeCount |
integer |
是 |
PolarDBX Search 資料節點數量。必須為正整數，並且是所選可用區數量的整數倍。 |
3 |
| InstanceSpec |
string |
否 |
相容性參數，目前不生效。請透過 DBNodeClass 指定 PolarDBX Search 資料節點規格。 |
opensearch.sn2ne.large.1 |
| StorageType |
string |
否 |
儲存類型。預設值為 cloud_auto。 |
cloud_auto |
| StorageSpace |
integer |
否 |
單節點儲存空間，單位為 GB。必須為正整數。 |
20 |
| DBInstanceDescription |
string |
否 |
執行個體備註描述。 |
測試執行個體 |
| ClientToken |
string |
否 |
冪等請求字串，保持每次建立不同即可。 |
FEA5DC20-6D8A-5979-97AA-FC57546ADC20 |
| ResourceGroupId |
string |
否 |
可以為空，資源群組 ID，暫時不支援。 |
rg-xxxxx |
| Period |
string |
否 |
收費週期，包年包月只能選 Year、Month，按量付費預設選擇 Hour。 |
Month |
| UsedTime |
integer |
否 |
預付費時，可以選擇購買幾個月或幾年。 說明
當 Period 設定為 Year 時，此參數支援的取值為 1、2、3。 |
1 |
| AutoRenew |
boolean |
否 |
是否自動續費，預設為 true。
|
true |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| RequestId |
string |
請求 ID。 |
C457B28E-9CAB-4B77-B5C6-5D71B7870B6E |
| Data |
object |
操作結果。 |
|
| DBInstanceName |
string |
執行個體名稱。 |
pxsp-********* |
| OrderId |
string |
訂單 ID。 |
265325896860727 |
| AccessDeniedDetail |
object |
無權限存取詳情。 |
|
| AuthAction |
string |
鑑權動作。 |
xxx |
| AuthPrincipalType |
string |
說明如上。 |
222 |
| AuthPrincipalOwnerId |
string |
鑑權主體的主帳號 ID。 |
111 |
| AuthPrincipalDisplayName |
string |
鑑權主體名稱。 |
xxx |
| PolicyType |
string |
策略類型。 |
PRIORITY |
| NoPermissionType |
string |
NoPermissionType |
ImplicitDeny |
| EncodedDiagnosticMessage |
string |
編碼診斷資訊。 |
AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg== |
樣本
正常返回樣本
JSON格式
{
"RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
"Data": {
"DBInstanceName": "pxsp-*********",
"OrderId": "265325896860727"
},
"AccessDeniedDetail": {
"AuthAction": "xxx",
"AuthPrincipalType": "222",
"AuthPrincipalOwnerId": "111",
"AuthPrincipalDisplayName": "xxx",
"PolicyType": "PRIORITY",
"NoPermissionType": "ImplicitDeny",
"EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。