tencent cloud

文档反馈

ModifyPlan

最后更新时间:2024-10-11 15:52:44

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

Modify the plan settings. Currently, only the auto-renewal switch of prepaid plans can be modified.

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: ModifyPlan.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
PlanId Yes String Plan ID, formatted as edgeone-2unuvzjmmn2q.
RenewFlag No RenewFlag Auto-renewal configuration item in a prepaid plan. If auto-renewal is enabled, the plan will be automatically renewed one day before it expires. This feature is only available for Personal, Basic, and Standard Edition Plans. If this field is not specified, the original configuration will be retained.

3. Output Parameters

Parameter Name Type Description
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 Modifying Auto-Renewal Tag for Prepaid Plan

Enable the auto-renewal feature for the prepaid plan edgeone-2unuvzjmmn2q.

Input Example

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

{
    "PlanId": "edgeone-2unuvzjmmn2q",
    "RenewFlag": {
        "Switch": "on"
    }
}

Output Example

{
    "Response": {
        "RequestId": "6a617014-efc9-45c6-ba9d-c87d70472461"
    }
}

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

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter.PlanNotFound The plan doesn’t exist.
OperationDenied.EnterprisePlanAutoRenewUnsupported The Enterprise Edition Plan does not support auto-renewal.
OperationDenied.PlanHasBeenIsolated The plan has been isolated.