Change
Function
This API is used to update the order information of a yearly/monthly product and return the information about the order to be paid.

Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
POST /v3/{project_id}/orders/change
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
cloud_service_console_url |
No |
String |
Cloud service console URL. The URL used to switch to the cloud service console to view information after the subscription is complete. (This parameter is used only for manual payment.) |
product_info |
Yes |
CbcProductInfoOrderChange object |
Product information. |
resource_id |
Yes |
String |
ID of the resource to be changed. The value is in UUID format. You can query the resource status based on the type of the resource to be backed up. |
is_auto_pay |
No |
Boolean |
Specifies whether to automatically pay for the order. The default value is false. The options are as follows:
|
promotion_info |
No |
String |
Purchase discount. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
product_id |
Yes |
String |
Product ID, which is obtained through the price query API. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-). |
resource_size |
Yes |
Integer |
Resource capacity, in GB. The value ranges from 10 to 10485760. |
resource_size_measure_id |
No |
Integer |
Resource capacity measurement ID. An enumerated value is as follows: 17: GB |
resource_spec_code |
Yes |
String |
Resource specification code. Enum: [vault.backup.server.normal, vault.backup.turbo.normal, vault.backup.database.normal, vault.backup.volume.normal, vault.backup.rds.normal, vault.replication.server.normal, vault.hybrid.server.normal] |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
orderId |
String |
Order ID |
retCode |
String |
Change status code |
retMsg |
String |
Change information |
Example Requests
Changing the size of a yearly/monthly vault to 50 GB
https://{endpoint}/v3/{project_id}/orders/change { "resource_id" : "9dd8f8db-a926-440b-9af5-81b643618898", "product_info" : { "product_id" : "00301-34090-0--0", "resource_size" : 200, "resource_spec_code" : "vault.backup.server.normal" } }
Example Responses
Status code: 200
OK
{ "orderId" : "CS2305291628MSG5A", "retCode" : 0, "retMsg" : "success" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot