Enabling Automatic Subscription Renewal for Yearly/Monthly Resources

Function

A customer can use this API to enable automatic subscription renewal for its long-term yearly/monthly resources to prevent the resources from being deleted when they are expired.

Customers can follow the instructions described in Enabling Auto-Renewal to enable automatic subscription renewal for yearly/monthly resources in Billing Center.

The customer can enable automatic subscription renewal only after the customer successfully pays its yearly/monthly resource order.
For details about the yearly/monthly products supporting automatic subscription renewal, see Auto-Renewal Rules.
Before invoking this API, you can invoke the API described in Querying Customer's Yearly/Monthly Resources to query the resource ID, resource expiration date, and deduction policy after the resource is expired.
After you enable automatic subscription renewal, the fee will be deducted at 03:00 7 days before the product expiration date. Ensure that you have enough . If the first attempt to deduct the fee fails due to the , the system will continue the attempts at 03:00 every day until the fee is deducted successfully, or will retain the product resources till the last allowed day.
For the original billing mode of a resource, the renewal period is minimum subscription term of the product.

Constraints

This API can only be invoked using the customer AK/SK or token.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

POST /v2/orders/subscriptions/resources/autorenew/{resource_id}

The following table describes the parameters.

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
resource_id	Yes	String	Definition: Resource ID. Constraints: You can obtain the resource ID by invoking the API described in Querying Customer's Yearly/Monthly Resources. The attached resource IDs will be configured together when you configure primary resource IDs. For example, ECS is the primary resource, and EVS is the attached resource. If the shared bandwidth is used, the bandwidth is the primary resource, and EIPs are the attached resource. If the exclusive bandwidth is used, EIPs are the primary resources, and the bandwidth is the attached resource. If automatic renewal is enabled for the secondary resource, the primary resource will also be renewed. Range: A maximum of 64 characters Default Value: N/A

Request

Request Parameters

Parameter	Mandatory	Type	Description
auto_renew_times	No	Integer	Definition: Number of auto renewals. Auto renewal will end after the specified number of auto renewals is reached. Constraints: If auto-renewal is enabled for the first time, and this parameter is not included in the request parameters or is set to null, there is no limit to the number of auto renewals. If auto-renewal has been enabled, this parameter is mandatory when the number of auto renewals is reset. Otherwise, this parameter is not processed or modified. Range: [0-99] NOTE: The value 0 indicates that the number of auto renewals is not limited. Default Value: N/A

Parameter

Mandatory

Type

Description

auto_renew_times

Integer

Definition:

Number of auto renewals. Auto renewal will end after the specified number of auto renewals is reached.

Constraints:

If auto-renewal is enabled for the first time, and this parameter is not included in the request parameters or is set to null, there is no limit to the number of auto renewals.

If auto-renewal has been enabled, this parameter is mandatory when the number of auto renewals is reset. Otherwise, this parameter is not processed or modified.

Range:

[0-99]

NOTE:

The value 0 indicates that the number of auto renewals is not limited.

Default Value:

N/A

Example Request

POST https://bss-intl.myhuaweicloud.com/v2/orders/subscriptions/resources/autorenew/eb1cac79-773b-414b-8915-6c3eed8ddf24 HTTP/1.1
Content-Type: application/json
X-Auth-Token: MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ
{
    "auto_renew_times": 3
}

Response

Response Parameters

Parameter	Type	Description
error_code	String	Definition: Status code. For details, see Returned Values.
error_msg	String	Definition: Error description.

Parameter

Type

Description

error_code

String

Definition:

Status code.

For details, see Returned Values.

error_msg

String

Definition:

Error description.

Example Response

HTTP/1.1 204 No Content
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time

Returned Values

4xx: This class of HTTP status code is intended for situations in which the error seems to have been caused by the client, for example, the request contains bad syntax or incorrect parameters. You must ensure the request is correct.
5xx: This class of HTTP status code is intended for cases in which the Huawei Cloud server is aware that it has encountered an error or is otherwise incapable of performing the request. In this case, contact Huawei Cloud customer service.

HTTP Value	Error Code	Description
400	CBC.0100	Parameter error.
400	CBC.99003012	The resource ID does not exist.
400	CBC.99003602	Automatic renewal is not supported for expired or frozen resources.
403	CBC.0151	Access denied.
500	CBC.0999	Other errors.