在新購實例或對實例進行變配之前,評估是否有足夠的資源。
接口說明
本接口適用于 MongoDB 副本集、分片集群資源的評估。支持評估新購資源以及副本集、分片集群或單個分片的變配。
說明
本接口每分鐘調用不得超過 200 次,超出會被限制流量。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯(lián)操作:是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
---|---|---|---|---|
dds:EvaluateResource | none |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID,您可以調用 DescribeRegions 查詢。 | cn-hangzhou |
ZoneId | string | 是 | 可用區(qū) ID,您可以調用 DescribeRegions 查詢。 | cn-hangzhou-h |
Engine | string | 否 | 數(shù)據(jù)庫引擎,取值:MongoDB。 | MongoDB |
EngineVersion | string | 是 | 數(shù)據(jù)庫版本號。 | 4.2 |
DBInstanceClass | string | 否 | 實例規(guī)格。 說明
評估副本集資源時必須配置該參數(shù),規(guī)格詳情請參見實例規(guī)格表。
| dds.mongo.mid |
ShardsInfo | string | 否 | 分片集群的分片信息,評估分片集群資源時必須配置該參數(shù)。 評估新購分片集群資源時,需指定每個分片的規(guī)格,格式為 JSON 格式字符串。示例如下:
示例中參數(shù)說明如下:
評估分片集群變配資源時,僅需指定節(jié)點信息即可,格式為 JSON 格式字符串。示例如下:
示例中參數(shù)說明如下:
| {"NodeId": "d-bp147c4d9ca7****", "NodeClass": "dds.shard.standard"} |
DBInstanceId | string | 否 | 實例 ID,評估變配資源時必須配置該參數(shù)。 | dds-bp14bf67a76d**** |
ReplicationFactor | string | 否 | 設置實例的節(jié)點個數(shù)。
說明
Serverless 實例不需要配置該參數(shù)。
| 3 |
ReadonlyReplicas | string | 否 | 設置實例中只讀節(jié)點的個數(shù),取值范圍為 1~5。 說明
單節(jié)點實例 | 1 |
Storage | string | 否 | 副本集的存儲空間,單位為 GB。 說明
實例規(guī)格為云盤型時,該參數(shù)必填。
| 10 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"DBInstanceAvailable": "1",
"EngineVersion": "4.0",
"RequestId": "AE2DE465-E45F-481F-ABD8-37D64173****",
"Engine": "MongoDB"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-06-27 | API 內部配置變更,不影響調用 | 查看變更詳情 |