在新購執行個體或對執行個體進行變更配置之前,評估是否有足夠的資源。
介面說明
本介面適用於 MongoDB 複本集、分區叢集資源的評估。支援對複本集和分區叢集的新購、變更配置,以及分區叢集新增節點進行資源評估。
本介面每分鐘調用不得超過 200 次,超出會被限制流量。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
dds:EvaluateResource |
none |
*全部資源
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| RegionId |
string |
是 |
地區 ID,您可以調用 DescribeRegions 查詢。 |
cn-hangzhou |
| ZoneId |
string |
是 |
可用性區域 ID,您可以調用 DescribeRegions 查詢。 |
cn-hangzhou-h |
| Engine |
string |
否 |
資料庫引擎,取值:MongoDB。 |
MongoDB |
| EngineVersion |
string |
是 |
資料庫版本號碼。 枚舉值:
|
4.2 |
| DBInstanceClass |
string |
否 |
執行個體規格。 說明
評估複本集資源時必須配置該參數,規格詳情請參見執行個體規格表。 |
dds.mongo.mid |
| ShardsInfo |
string |
否 |
分區叢集的分區資訊,評估分區叢集資源時必須配置該參數。 評估新購分區叢集資源時,需指定每個分區的規格,格式為 JSON 格式字串。樣本如下:
樣本中參數說明如下:
評估分區叢集變更配置資源時,僅需指定節點資訊即可,格式為 JSON 格式字串。樣本如下:
樣本中參數說明如下:
|
{"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"} |
| DBInstanceId |
string |
否 |
執行個體 ID,評估變更配置資源時必須配置該參數。 |
dds-bp14bf67a76d**** |
| ReplicationFactor |
string |
否 |
設定執行個體的節點個數。
|
3 |
| ReadonlyReplicas |
string |
否 |
設定執行個體中唯讀節點的個數,取值範圍為 1~5。 說明
單節點執行個體不需要配置該參數。 |
1 |
| Storage |
string |
否 |
複本集的儲存空間,單位為 GB。 說明
執行個體規格為雲端硬碟型時,該參數必填。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| DBInstanceAvailable |
string |
展示目前範圍是否有可用的資源。傳回值:
|
1 |
| EngineVersion |
string |
資料庫版本號碼。 |
4.0 |
| RequestId |
string |
請求 ID。 |
AE2DE465-E45F-481F-ABD8-37D64173**** |
| Engine |
string |
資料庫引擎,固定為 MongoDB。 |
MongoDB |
樣本
正常返回樣本
JSON格式
{
"DBInstanceAvailable": "1",
"EngineVersion": "4.0",
"RequestId": "AE2DE465-E45F-481F-ABD8-37D64173****",
"Engine": "MongoDB"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。