Modifies the configurations of an instance. When you call this operation, the system generates a modification order and automatically completes the payment. You cannot call this operation to modify the configurations of an Elastic Compute Service (ECS) instance or ApsaraDB RDS instance. To modify the configurations of an ECS or ApsaraDB RDS instance, call the dedicated operation of the corresponding service.
Debugging
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 Resourcesis 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 |
|---|---|---|---|---|
| bssapi:ModifyInstance | WRITE |
|
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProductCode | string | Yes | The code of the service to which the instance belongs. | rds |
| ProductType | string | No | The type of the service to which the instance belongs. | rds |
| SubscriptionType | string | Yes | The billing method. Valid values:
| Subscription |
| ModifyType | string | Yes | The type of configuration modifications. Valid values:
| Upgrade |
| InstanceId | string | No | The ID of the instance for which you want to modify the configurations. | rm-akjhkdsjhfskjfhd |
| ClientToken | string | No | The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. | JAKSJFHFAKJSF |
| Parameter | object [] | No | The details about the parameters. | |
| Value | string | Yes | The value of the parameter n. Valid values of n: 1 to 100. | test |
| Code | string | Yes | The code of the parameter n. Valid values of n: 1 to 100. Multiple parameters are concatenated in the order of n. Note
Only the parameters of the attributes that you want to modify for the instance must be configured. For example, if the instance has Attribute A and Attribute B and only Attribute A must be modified, configure only the parameter of Attribute A.
| test |
Response parameters
Examples
Sample success responses
JSONformat
{
"Code": "Success",
"Message": "Successful！",
"RequestId": "6000EE23-274B-4E07-A697-FF2E999520A4",
"Success": true,
"Data": {
"OrderId": "202653252354351",
"HostId": "testId"
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InvalidOwner | The specified owner doesn't belong to caller. | Invalid user identity. |
| 400 | ResourceNotExists | The specific resource is not exists. | - |
| 400 | ORDER.ACCOUNT_STATUS_ILLEGAL | Please complete your basic personal information first. | - |
| 500 | InternalError | The request processing has failed due to some unknown error. | - |
For a list of error codes, visit the Service error codes.