調用DescribeParameters API查詢執行個體參數配置資訊-ApsaraDB for MongoDB-阿里雲 - ApsaraDB for MongoDB

查詢MongoDB執行個體的參數配置資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

dds:DescribeParameters

get

*dbinstance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

無

請求參數

名稱	類型	必填	描述	樣本值
DBInstanceId	string	是	執行個體 ID。說明當本參數傳入的是分區叢集執行個體 ID 時，還需要傳入 NodeId 參數。	dds-bpxxxxxxxx
NodeId	string	否	分區叢集執行個體中的 Mongos 節點 ID 或 Shard 節點 ID。說明當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，本參數才可用。	d-bpxxxxxxxx
CharacterType	string	否	執行個體的角色類型，取值說明： db：shard 角色。 cs：config server 角色。 mongos：mongos 角色。	mongos
ExtraParam	string	否	擴充參數。	terrform

返回參數

名稱	類型	描述	樣本值
	object
RunningParameters	object
Parameter	array<object>	當前啟動並執行參數配置資訊列表。
	object
CheckingCode	string	參數取值範圍。	[33554432-268435456]
ParameterName	string	參數名。	setParameter.internalQueryExecMaxBlockingSortBytes
ParameterValue	string	參數值。	33554432
ForceRestart	string	修改參數後是否需要重啟生效。 false：無需重啟，提交後即生效。 true：需要重啟生效。	false
ParameterDescription	string	參數描述。	The maximum memory bytes that sort stage may use, default is 33554432(i.e. 32MB)
ModifiableStatus	string	參數是否處於可修改的狀態。 false：不可修改。 true：可修改。	true
CharacterType	string	執行個體的角色類型，取值說明： db：shard 角色。 cs：config server 角色。 mongos：mongos 角色。	db
EngineVersion	string	資料庫版本號碼。	4.0
RequestId	string	請求 ID。	3ADD0C7D-2D2A-4F15-88FF-E7AC9B9FDCC8
ConfigParameters	object
Parameter	array<object>	配置中的參數配置資訊列表。
	object
CheckingCode	string	參數取值範圍。	[0-65536]
ParameterName	string	參數名。	operationProfiling.slowOpThresholdMs
ParameterValue	string	參數值。	200
ForceRestart	boolean	修改參數後是否需要重啟生效。 false：無需重啟，提交後即生效。 true：需要重啟生效。	true
ParameterDescription	string	參數描述。	The threshold in milliseconds at which the database profiler considers a query slow, default is 100.
ModifiableStatus	boolean	參數是否處於可修改的狀態。 false：不可修改。 true：可修改。	true
Engine	string	資料庫引擎，預設返回 mongodb。	mongodb

樣本

正常返回樣本

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.	所選執行個體規格不存在，請重新選擇。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。