All Products
Search
Document Center

ApsaraDB for MongoDB:ModifyDBInstanceDescription

Last Updated:Mar 15, 2024

Modifies the name of an ApsaraDB for MongoDB instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dds:ModifyDBInstanceDescriptionWRITE
  • dbinstance
    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID.

Note To modify the name of a shard or mongos node in a sharded cluster instance, you must also specify the NodeId parameter.
dds-bp2234****
NodeIdstringNo

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.
d-bp89067****
DBInstanceDescriptionstringYes

The name of the instance.

Note
  • The name cannot start with http:// or https://.

  • It must start with a letter.

  • It must be 2 to 256 characters in length, and can contain letters, underscores (_), hyphens (-), and digits.

testdata

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The request ID.

06F8F642-4009-4FFC-80C4-9D67DBF7B74E

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400InvalidDBInstanceDescription.MalformedSpecified parameter DBInstanceDescription is not valid.Invalid node name.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history