Overview
Menu

CreatePlanForZone

1. API Description

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

This API is used to purchase a plan for a new site.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: CreatePlanForZone.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringID of the site.
PlanTypeYesStringThe plan option. Values:
  • sta: Standard plan that supports content delivery network outside the Chinese mainland.
  • sta_with_bot: Standard plan that supports content delivery network outside the Chinese mainland and bot management.
  • sta_cm: Standard plan that supports content delivery network inside the Chinese mainland.
  • sta_cm_with_bot: Standard plan that supports content delivery network inside the Chinese mainland and bot management.
  • sta_global: Standard plan that supports content delivery network over the globe.
  • sta_global_with_bot: Standard plan that supports content delivery network over the globe and bot management.
  • ent: Enterprise plan that supports content delivery network outside the Chinese mainland.
  • ent_with_bot: Enterprise plan that supports content delivery network outside the Chinese mainland and bot management.
  • ent_cm: Enterprise plan that supports content delivery network inside the Chinese mainland.
  • ent_cm_with_bot: Enterprise plan that supports content delivery network inside the Chinese mainland and bot management.
  • ent_global: Enterprise plan that supports content delivery network over the globe.
  • ent_global_with_bot: Enterprise plan that supports content delivery network over the globe and bot management.
  • To get the available plan options for your account, view the output from DescribeAvailablePlans.

    3. Output Parameters

    Parameter NameTypeDescription
    ResourceNamesArray of StringList of purchased resources.
    DealNamesArray of StringList or order numbers.
    RequestIdStringThe 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 CreatePlanForZone

    This example shows you how to create a plan for a zone.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: CreatePlanForZone
    <Common Request Parameters>
    
    {
        "ZoneId": "zone-25z65bfb4414",
        "PlanType": "sta"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "a06f52e7-2aab-4510-b2c2-1065bfb4414c",
            "ResourceNames": [
                "plan_sta"
            ],
            "DealNames": [
                "2022080135400110011001"
            ]
        }
    }
    

    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 CodeDescription
    FailedOperationOperation failed.
    FailedOperation.InsufficientAccountBalanceInsufficient account balance
    InternalError.ProxyServerAn unknown error occurred in the backend server.
    InvalidParameter.ZoneHasBeenBoundThe site is already bound.
    OperationDeniedOperation denied.
    OperationDenied.DomainNoICPThe domain name doesn't have an ICP filing number.