All Products
Search

This Product

    Elastic Desktop Service:RenewDesktops

    Document Center

    Elastic Desktop Service:RenewDesktops

    Last Updated:Mar 17, 2026

    Renews one or more subscription-based WUYING Workspace instances.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    No authorization for this operation. If you encounter issues with this operation, contact technical support.

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    RegionId

    string

    Yes

    The region ID. Call DescribeRegions to list the regions where WUYING Workspace is available.

    cn-hangzhou
    Period

    integer

    No

    The renewal duration. Valid values depend on the value of PeriodUnit.

    • If PeriodUnit is Month, valid values are 1, 2, 3, and 6.

    • If PeriodUnit is Year, valid values are 1 to 5.

    Default value: 1.

    1
    PeriodUnit

    string

    No

    The unit for the renewal duration, which applies to the Period parameter.

    Valid values:

    • Month :

      Month [default]

    • Year :

      Year

    Month
    AutoPay

    boolean

    No

    Specifies whether to enable automatic payment.

    Valid values:

    • true :

      Enable automatic payment. Ensure your account balance is sufficient. Otherwise, an abnormal order is generated [default].

    • false :

      Create an order only. Do not pay. Log on to the console. Go to User Center > My Orders. Pay using the returned order ID.

    true
    DesktopId

    array

    Yes

    A list of WUYING Workspace instance IDs. You can renew only instances purchased on a monthly basis.

    ecd-ia2zw38bi6cm7****

    string

    No

    A WUYING Workspace instance ID. You can renew only instances purchased on a monthly basis.

    ecd-ia2zw38bi6cm7****
    PromotionId

    string

    No

    The promotion ID.

    50003098015****
    ResourceType

    string

    No

    Note

    This field is not available for public use.

    null
    AutoRenew

    boolean

    No

    Specifies whether to enable auto-renewal.

    false
    ResellerOwnerUid

    integer

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The response data.

    OrderId

    string

    The order ID.

    20844399755****
    RequestId

    string

    The request ID.

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

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.