查詢MongoDB實例的參數配置信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dds:DescribeParameters | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID。 說明
當本參數傳入的是分片集群實例 ID 時，還需要傳入 NodeId 參數。
| dds-bpxxxxxxxx |
| NodeId | string | 否 | 分片集群實例中的 Mongos 節點 ID 或 Shard 節點 ID。 說明
當 DBInstanceId 參數傳入的是分片集群實例 ID 時，本參數才可用。
| d-bpxxxxxxxx |
| CharacterType | string | 否 | 實例的角色類型，取值說明：
| mongos |
| ExtraParam | string | 否 | 擴展參數。 | terrform |
返回參數
示例
正常返回示例
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"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 403 | IncorrectDBInstanceType | Current DB instance type does not support this operation. | 當前實例類型不支持該操作。 |
| 404 | InvalidDBInstanceClass.NotFound | The specified DB instance type is not found. | 所選實例規格不存在，請重新選擇。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-03-15 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |