All Products
Search
Document Center

WUYING Workspace:RenewDesktops

Last Updated:Apr 08, 2024

Renew subscription cloud computers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
PeriodintegerNo

The renewal duration. Valid values of this parameter are determined by the value of the PeriodUnit parameter.

  • Valid values if you set the PeriodUnit parameter to Month: 1, 2, 3, and 6
  • Valid values if you set the PeriodUnit parameter to Year: 1, 2, 3, 4, 5, and 6

Default value: 1.

1
PeriodUnitstringNo

The unit of the renewal duration specified by the Period parameter.

Default value: Month. Valid values:

  • Month

  • Year

Month
AutoPaybooleanNo

Specifies whether to enable the auto-payment feature.

Default value: true. Valid values:

  • true: enables the auto-payment feature.

    Make sure that you have sufficient balance in your Alibaba Cloud account. Otherwise, your order becomes invalid.

  • false: disables the auto-payment feature. In this case, an order is generated, and no payment is automatically made.

    You can log on to the WUYING Workspace console and complete the payment based on the order ID on the Orders page.

true
DesktopIdarrayYes

The IDs of the cloud computers. Only IDs of subscription cloud computers are supported.

stringYes

The ID of a cloud computer. Only the ID of a subscription cloud computer is supported.

ecd-ia2zw38bi6cm7****
PromotionIdstringNo

The ID of the promotional activity.

500030980150146

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

OrderIdstring

The order ID.

20844399755****
RequestIdstring

The request ID.

1CBAFFAB-B697-4049-A9B1-67E1FC5F****

Examples

Sample success responses

JSONformat

{
  "OrderId": "20844399755****",
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2021-08-19The request parameters of the API has changedsee changesets
Change itemChange content
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: PromotionId