Modifies the resource configuration of an instance. Invoking this operation creates an order for the Upgrade/Downgrade of instance resources and processes automatic payment. This operation does not support configuration changes for ECS or RDS products. Use the dedicated API of the corresponding product to execute the Upgrade/Downgrade.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
bss:ModifyInstance |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProductCode |
string |
Yes |
The product code. |
rds |
| ProductType |
string |
No |
The product type. |
rds |
| SubscriptionType |
string |
Yes |
The billing method. Valid values:
|
Subscription |
| ModifyType |
string |
Yes |
The type of configuration change. Valid values:
|
Upgrade |
| InstanceId |
string |
No |
The instance ID of the instance whose configuration you want to modify. |
rm-akjhkdsjhfskjfhd |
| ClientToken |
string |
No |
The client token that is used to ensure the idempotence of the request and prevent duplicate submissions. |
JAKSJFHFAKJSF |
| Parameter |
array<object> |
No |
The list of parameters. |
|
|
object |
No |
|||
| Value |
string |
Yes |
The value of the nth module property. Valid values of n: 1 to 100. |
test |
| Code |
string |
Yes |
The code of the nth module property. Valid values of n: 1 to 100. If multiple module properties exist, concatenate the parameters in the format of n=1,2,3…n. Note
Specify only the module properties that need to be changed. For example, if only property A needs to be changed among properties A and B, pass only the information related to property A. |
test |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Code |
string |
The status code. |
Success |
| Message |
string |
The error message. |
Successful! |
| RequestId |
string |
The request ID. |
6000EE23-274B-4E07-A697-FF2E999520A4 |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Data |
object |
The returned data. |
|
| OrderId |
string |
The ID of the order that was created. |
202653252354351 |
| HostId |
string |
The host ID. |
testId |
Examples
Success response
JSON format
{
"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. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.