Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Operations/ Change
Updated on 2025-11-03 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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

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

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.) Default value: N/A

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 ID based on the type of the resource to be backed up. Default value: N/A

is_auto_pay

No

Boolean

Specifies whether to automatically pay for the order. The default value is false.

The options are as follows:

  • true: The payment is automatically made after the order is placed.

  • false: The payment is not automatically made after the order is placed.

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, in GB. Value Range: 10-10485760 Default value: N/A

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

Number

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