ModifyDBInstanceDescription -

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ModifyDBInstanceDescription	The operation that you want to perform. Set the value to ModifyDBInstanceDescription.
RegionId	String	No	cn-hangzhou	The region ID of the instance. You can call the DescribeRegions operation to query the region ID.
DBInstanceId	String	Yes	dds-bp2234****	The ID of the instance. Note To modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the NodeId parameter.
NodeId	String	No	d-bp89067****	The ID of the shard or mongos node in the sharded cluster instance. Note This parameter is valid only if you set the DBInstanceId parameter to the ID of a sharded cluster instance.
DBInstanceDescription	String	Yes	testdata	The name of the instance. Note The name cannot start with `http://` or `https://`. The name must start with a letter. The name must be 2 to 256 characters in length, and can contain letters, underscores (_), hyphens (-), and digits.

Response parameters


Parameter	Type	Example	Description
RequestId	String	06F8F642-4009-4FFC-80C4-9D67DBF7B74E	The ID of the request.

Examples

Sample requests

http(s)://mongodb.aliyuncs.com/?Action=ModifyDBInstanceDescription
&DBInstanceId=dds-bp2234****
&NodeId=d-bp89067****
&DBInstanceDescription=testdata
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyDBInstanceDescriptionResponse>
    <RequestId>06F8F642-4009-4FFC-80C4-9D67DBF7B74E</RequestId>
</ModifyDBInstanceDescriptionResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "06F8F642-4009-4FFC-80C4-9D67DBF7B74E"
}

Error codes

For a list of error codes, visit the API Error Center.