Help Center/ Cloud Backup and Recovery/ API Reference/ CBR APIs/ Operations/ Change
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
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

Definition

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

cloud_service_console_url

No

String

Definition

URL used to switch to the cloud service console to view information after the payment is made.

Constraints

This parameter is used only for manual payment.

Range

The value contains 1 to 512 characters.

Default Value

N/A

product_info

Yes

CbcProductInfoOrderChange object

Definition

Product information.

Constraints

Mandatory. For details, see the CbcProductInfoOrderChange table.

Range

N/A

Default Value

N/A

resource_id

Yes

String

Definition

ID of the resource to be changed. For details about how to obtain the resource ID, see Querying the Vault List.

Constraints

N/A

Range

N/A

Default Value

N/A

is_auto_pay

No

Boolean

Definition

Automatic payment.

Constraints

N/A

Range

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

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

Default Value

false

promotion_info

No

String

Definition

Purchase discount.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 CbcProductInfoOrderChange

Parameter

Mandatory

Type

Description

product_id

Yes

String

Definition

Product ID, which can be obtained through the API for querying the price of a yearly/monthly product in the Customer Operations.

Constraints

N/A

Range

The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default Value

N/A

resource_size

Yes

Integer

Definition

Resource capacity, in GB.

Constraints

N/A

Range

10–10485760 GB

Default Value

N/A

resource_size_measure_id

No

Integer

Definition

Resource capacity measurement ID. For example, the enumerated value 17 indicates GB.

Constraints

N/A

Range

N/A

Default Value

17

resource_spec_code

Yes

String

Definition

Resource specification code of the purchased cloud service product.

Constraints

N/A

Range

vault.backup.server.normal: server backup vault

vault.backup.turbo.normal: SFS Turbo backup vault

vault.backup.database.normal: database backup vault

vault.backup.volume.normal: disk backup vault

vault.backup.rds.normal: RDS backup vault

vault.replication.server.normal: server replication vault

vault.hybrid.server.normal: hybrid cloud server backup vault

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

orderId

String

Definition

Resource modification order ID.

Range

N/A

retCode

Number

Definition

Response code for the resource specification modification.

Range

N/A

retMsg

String

Definition

Response message for the modification.

Range

N/A

Example Requests

Changing the size of a yearly/monthly vault to 50 GB

POST https://{endpoint}/v3/{project_id}/orders/change

{
  "resource_id" : "9dd8f8db-a926-440b-9af5-81b643618898",
  "product_info" : {
    "product_id" : "00301-34090-0--0",
    "resource_size" : 50,
    "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