ModifyInstanceName - ApsaraDB for OceanBase - Alibaba Cloud Documentation Center

You can call this operation to change the name of an OceanBase cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
oceanbase:ModifyInstanceName	update	Instance acs:oceanbase:{#regionId}:{#accountId}:instance/{#InstanceId}/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	It is an Alibaba Cloud asset management and configuration tool, with which you can manage multiple Alibaba Cloud products and services by using commands. It is easy to use and a good helper in migration to cloud.	ob317v4uif****
InstanceName	string	Yes	The ID of the OceanBase cluster.	ob4prod

Response parameters

Parameter	Type	Description	Example
	object	The name of the OceanBase cluster. It must be 1 to 20 characters in length.
InstanceName	string	The name of the OceanBase cluster.	ob4test
RequestId	string	The operation that you want to perform. Set the value to ModifyInstanceName.	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C

Examples

Sample success responses

JSONformat

{
  "InstanceName": "ob4test",
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C"
}

Error codes

HTTP status code	Error code	Error message
2014	InternalError	The request processing has failed due to some unknown error.
9005	MissingInstanceId	InstanceId is mandatory for this action.
9006	MissingInstanceName	InstanceName is mandatory for this action.

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

Change history

Change time	Summary of changes	Operation
2023-07-04	The Error code has changed. The response structure of the API has changed	View Change Details