最近更新时间:2024.04.26 11:09:10
首次发布时间:2022.08.04 11:30:28
调用 DescribeDBInstanceParameters 接口查询指定实例支持的参数信息列表。
同步请求。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
InstanceId | String | 是 | mongo-replica-55d59354**** | 实例 ID。 说明 您可以调用 DescribeDBInstances 接口查询目标地域下所有 MongoDB 实例的基本信息,包括实例 ID。 |
ParameterRole | String | 否 | Node | 目标参数所属的节点类型,取值范围如下:
说明 您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括参数所属的节点类型。 |
ParameterNames | String | 否 | connPoolMaxConnsPerHost | 需要查找的参数名称。 说明
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
InstanceId | String | mongo-replica-55d59354**** | 实例 ID。 |
DBEngine | String | MongoDB | 数据库引擎。取值固定为 MongoDB 。 |
DBEngineVersion | String | MongoDB_4_0 | 数据库引擎版本,取值范围如下:
|
Total | String | 1 | 符合查询要求的参数个数。 |
InstanceParameters | Array of InstanceParametersObject | 请参见返回示例。 | 符合查询要求的所有参数详情列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
ForceModify | Boolean | true | 目标参数是否支持修改参数值。取值范围如下:
|
CheckingCode | String | 200 - 2000 | 参数的取值范围。 |
ForceRestart | Boolean | true | 修改后,新的参数值是否需要重启实例才生效。取值范围如下:
|
ParameterRole | String | Node | 目标参数所属的节点类型,取值范围如下:
说明 您可以调用 DescribeDBInstanceParameters 接口查询目标实例支持的参数详情,包括参数所属的节点类型。 |
ParameterType | String | Integer | 参数值的类型,取值范围如下:
|
ParameterNames | String | connPoolMaxConnsPerHost | 参数名。 |
ParameterValue | String | 1 | 目标参数的当前取值。 |
ParameterDescription | String | 表示当前实例与其他 mongod 实例通信的连接池的最大连接数 | 参数描述。 |
ParameterDefaultValue | String | 600 | 目标参数的默认值。 |
POST https://mongodb.volcengineapi.com/?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1 Host: mongodb.volcengineapi.com Content-Type: application/json; charset=utf-8 X-Date: 20201103T104027Z Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/mongodb/request,SignedHeaders=content-type;host;x-date,Signature=**** { "InstanceId": "mongo-replica-55d59354****", "ParameterNames": "pool" }
{ "ResponseMetadata": { "RequestId": "2022052716480301022508219902F0****", "Action": "DescribeDBInstanceParameters", "Version": "2022-01-01", "Service": "mongodb", "Region": "cn-beijing" }, "Result": { "DBEngine": "MongoDB", "DBEngineVersion": "MongoDB_4_0", "InstanceId": "mongo-replica-55d59354****", "InstanceParameters": [ { "CheckingCode": "200 - 2000", "ForceModify": true, "ForceRestart": true, "ParameterDefaultValue": "600", "ParameterDescription": "表示当前实例与其他mongod实例通信的连接池的最大连接数", "ParameterNames": "connPoolMaxConnsPerHost", "ParameterRole": "Node", "ParameterType": "Integer", "ParameterValue": "601" } ], "Total": "1" } }