DescribeRenewInstances

Last updated:2026-03-26 11:43:16

DescribeRenewInstances

Last updated: 2026-03-26 11:43:16

1. API Description

Domain name for API request: billing.intl.tencentcloudapi.com.

Notes:

This API supports querying annual and monthly subscription instances integrated into the renewal management page, including running and isolated instances (some products unsupported).
When using this API, a sub-user should have the QcloudFinanceRenewManageFullAccess permission policy.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: DescribeRenewInstances.
Version	Yes	String	Common Params. The value used for this API: 2018-07-09.
Region	No	String	Common Params. This parameter is not required.
MaxResults	Yes	Integer	Maximum number of instances per page. Value range: 1-100.
NextToken	No	String	Token for querying the next page of returned results. NextToken is not needed when calling the API for the first time.
Reverse	No	Boolean	Get the sorting order of the instance. The enumerated values are as follows: false = Ascending (default) true=Descending
RenewFlagList.N	No	Array of String	Renewal flag. Multiple values separated by commas. Enumeration value as follows: NOTIFY_AND_MANUAL_RENEW: manual renewal. NOTIFY_AND_AUTO_RENEW: automatic renewal. DISABLE_NOTIFY_AND_MANUAL_RENEW: non-renewal upon expiration.
InstanceIdList.N	No	Array of String	Instance ID. Multiple IDs separated by commas, with a maximum of 100.
ExpireTimeStart	No	String	Expiry time start, format yyyy-MM-dd HH:mm:ss.
ExpireTimeEnd	No	String	Expiry time in the format of yyyy-MM-dd HH:mm:ss.

3. Output Parameters

Parameter Name	Type	Description
InstanceList	Array of RenewInstance	Instance summary list.
NextToken	String	Token for querying the next page of returned results. Note: This field may return null, indicating that no valid values can be obtained.
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example 1

Input Example

POST / HTTP/1.1
Host: billing.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRenewInstances
<Common request parameters>

{
    "MaxResults": 10,
    "NextToken": "VDAwMSu3Y69lZhLwW1bRxLiwKafWBv_6TqKBnp-YH12b0uWcwTBf3DIK7Myza6EVdhDKoFGpKANnZkfmmLy5K8uH1lJYqyvuT_mSXc8VoOdX-8kcKJrB3JbyW9dM0edrKm3Q",
    "Reverse": true,
    "RenewFlagList": [
        "DISABLE_NOTIFY_AND_MANUAL_RENEW"
    ],
    "InstanceIdList": [
        "std_storage-20241106185002290002691-0"
    ],
    "ExpireTimeStart": "2025-06-26 00:38:46",
    "ExpireTimeEnd": "2025-09-27 15:38:46"
}

Output Example

{
    "Response": {
        "InstanceList": [
            {
                "ExpireTime": "2025-07-06 23:59:59",
                "InstanceId": "std_storage-20241106185002290002691-0",
                "InstanceName": "",
                "ProductCode": "p_cos",
                "ProductName": "COS u5bf9u8c61u5b58u50a8",
                "ProjectName": "u9ed8u8ba4u9879u76ee",
                "RegionCode": "ap-others",
                "RenewFlag": "DISABLE_NOTIFY_AND_MANUAL_RENEW",
                "RenewPeriod": 1,
                "RenewPeriodUnit": "m",
                "Status": "NORMAL",
                "SubProductCode": "sp_cos_pkg_std_new"
            }
        ],
        "NextToken": null,
        "RequestId": "6e1a3451-b75c-4d7d-bbbd-e363682ab0af"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud