Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Operations/ Change
Updated on 2024-12-20 GMT+08:00
View PDF
Share

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.

This API is in the open beta test (OBT) phase and may be unavailable in some regions.

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

cloud_service_console_url

No

String

URL of the cloud service console. After the subscription is completed, this URL can be used to switch to the cloud service console page to view the information.

product_info

Yes

CbcProductInfoOrderChange object

Product information.

resource_id

Yes

String

ID of the resource to be changed.

is_auto_pay

No

Boolean

Whether to enable automatic payment. The default value is false.

NOTE:

This feature is in the open beta test (OBT) phase and may be unavailable or does not take effect in some regions.

promotion_info

No

String

Purchase discount.
Table 3 CbcProductInfoOrderChange

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. Value range: 10-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

Table 4 Response body parameters

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.

Parent topic: Operations