查詢MongoDB實(shí)例的參數(shù)配置信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級別:是指每個(gè)操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
dds:DescribeParameters | get |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 實(shí)例 ID。 說明
當(dāng)本參數(shù)傳入的是分片集群實(shí)例 ID 時(shí),還需要傳入 NodeId 參數(shù)。
| dds-bpxxxxxxxx |
NodeId | string | 否 | 分片集群實(shí)例中的 Mongos 節(jié)點(diǎn) ID 或 Shard 節(jié)點(diǎn) ID。 說明
當(dāng) DBInstanceId 參數(shù)傳入的是分片集群實(shí)例 ID 時(shí),本參數(shù)才可用。
| d-bpxxxxxxxx |
CharacterType | string | 否 | 實(shí)例的角色類型,取值說明:
| mongos |
ExtraParam | string | 否 | 擴(kuò)展參數(shù)。 | terrform |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RunningParameters": {
"Parameter": [
{
"CheckingCode": "[33554432-268435456]",
"ParameterName": "setParameter.internalQueryExecMaxBlockingSortBytes",
"ParameterValue": "33554432",
"ForceRestart": "false",
"ParameterDescription": "The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)",
"ModifiableStatus": "true",
"CharacterType": "db"
}
]
},
"EngineVersion": "4.0",
"RequestId": "3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8",
"ConfigParameters": {
"Parameter": [
{
"CheckingCode": "[0-65536]",
"ParameterName": "operationProfiling.slowOpThresholdMs",
"ParameterValue": "200",
"ForceRestart": true,
"ParameterDescription": "The threshold in milliseconds at which the database profiler considers a query slow, default is 100.",
"ModifiableStatus": true
}
]
},
"Engine": "mongodb"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 當(dāng)前實(shí)例類型不支持該操作。 |
404 | InvalidDBInstanceClass.NotFound | The specified DB instance type is not found. | 所選實(shí)例規(guī)格不存在,請重新選擇。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2023-03-15 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |