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

Change

Function

Updates yearly/monthly order information after the order is paid.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v3/{project_id}/orders/{order_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

order_id

Yes

String

Order ID

project_id

Yes

String

Project ID

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

cloudServiceConsoleURL

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.

Minimum: 1

Maximum: 512

productInfo

Yes

CbcProductInfoUpdate object

Product information

resourceId

Yes

String

ID of the resource to be changed

promotion_info

No

String

Promotion information
Table 3 CbcProductInfoUpdate

Parameter

Mandatory

Type

Description

productId

Yes

String

Product ID, which is obtained by calling the API for price inquiry. The value consists of 1 to 64 characters and can contain only letters, digits, underscores (_), and hyphens (-)..

Minimum: 1

Maximum: 64

resourceSize

Yes

Integer

Specifies the resource size. The value ranges from 10 to 10,485,760.

Minimum: 10

Maximum: 10485760

resourceSizeMeasureId

No

Integer

Resource capacity measurement ID. An enumerated value is as follows: 17: GB

Default: 17

resourceSpecCode

Yes

String

Resource specifications of the purchased cloud service Enumeration values: 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

Enumeration values:

  • 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 capacity of a yearly/monthly vault to 50 GB

https://{endpoint}/v3/{project_id}/orders/CS2305081601LIS2V

{
  "resourceId" : "9dd8f8db-a926-440b-9af5-81b643618898",
  "productInfo" : {
    "productId" : "00301-231147-0--0",
    "resourceSpecCode" : "vault.backup.server.normal",
    "resourceSize" : 50,
    "resourceSizeMeasureId" : 17
  }
}

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