tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeAddableEntityList

最后更新时间：2023-05-25 17:35:50
This document is currently invalid. Please refer to the documentation page of the product.

1. API Description

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

This API is used to query available shipping entities.

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: DescribeAddableEntityList.
Version Yes String Common Params. The value used for this API: 2022-09-01.
Region No String Common Params. This parameter is not required.
ZoneId Yes String ID of the site.
EntityType Yes String Type of the shipping entity. Values:
  • domain: L7 acceleration logs;
  • application: L4 acceleration logs;
  • web-rateLiming: Rate limiting logs;
  • web-attack: Web security logs;
  • web-rule: Custom rule logs;
  • web-bot: Bot management logs.
    		•
    Area No String The service region. Values:
  • mainland: Chinese mainland.
  • overseas: Regions outside the Chinese mainland.
    • For an account registered on the Chinese site, it defaults to mainland. For an account registered on the international site, it defaults to overseas.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Total number of query results.
    EntityList Array of String List of available shipping entities.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 This example shows you how to query available L4 proxies.

    Input Example

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

{
    "EntityType": "domain",
    "ZoneId": "zone-28v4ag8bprrm",
    "Area": "mainland"
}

    Output Example

    {
    "Response": {
        "TotalCount": 1,
        "EntityList": [
            "sub.example.com"
        ],
        "RequestId": "8fbf8770-6bc2-48e1-a544-bf06eb8481e6"
    }
}

    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
    ResourceUnavailable.ProxyZoneNotFound No proxied sites found
    UnauthorizedOperation.CamUnauthorized CAM is not authorized.
    UnauthorizedOperation.NoPermission The sub-account is not authorized for the operation. Please get permissions first.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款