Query Domain Name List

Last updated: 2020-06-05 20:03:03

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new CDN API 3.0 which is standardized and faster.

    1. API Description

    This API (DescribeCdnHosts) is used to query the details of all domains, including configuration information. Paged query is supported.

    Domain name for API request:cdn.api.qcloud.com

    2. Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. See the Common Request Parameters page for details. The Action field for this API is DescribeCdnHosts.

    Parameter Name Required Type Description
    offset No Int Offset; default value is 0
    limit No Int Number of returned results. Return all by default

    Note

    • If there are a large number of domains, you can use "offset" and "limit" for paged queries. But it is not mandatory. You can fully return domain information;
    • The limit of API call frequency is 100 times per minute. If the limit is exceeded, it will return an error. Do not call with high frequency.

    3. Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Succeeded; other values: Failed. For more information, refer to Common Error Codes on Error Code page.
    message String Module error message description depending on API.
    codeDesc String English error message or error code at business side.
    data Array Result data, as described below

    data Field Description

    Parameter Name Type Description
    hosts Array Domain details array
    total Int Total number of domains

    hosts Field Description

    Parameter Name Type Description
    id Int ID after the domain is connected to CDN
    app_id Int APPID of domain owner
    owner_uin Int QQ ID of the user when logging in to Tencent Cloud
    project_id Int Project ID of the domain
    host String Domain
    host_type String Connection method. There are three modes: "cos" means the hosted origin when connecting the domain is COS origin; "cname" means self-owned origin is used when connecting the domain; "ftp" means FTP hosted origin provided by CDN is used when connecting the domain.
    service_type String Domain content type. There are three modes: "web" means it is static content; "download" means it is downloading content; "media" means it is media streaming content.
    origin String Origin server configuration corresponding to the domain
    cache Array Configuration of caching rules, as described below
    status Int Domain state: "1" means the domain is in review; "2" means the domain is not approved ; "3" means the domain is approved for deploying; "4" means the domain is in deploying status; "5" means the domain is activated; "6" means the domain is closed.
    disabled Int Indicate whether the domain is blocked; "0" indicates that the domain is not blocked.
    message String Domain status information, such as "Closed", "Activated" and "Deploying".
    enable_overseas String Indicate whether the overseas CDN is activated: "no" means the overseas CDN is not activated; "yes" means the overseas CDN is activated.
    create_time String Domain connection time
    update_time String Last update time
    deleted String Delete or not: "no" means the domain is not deleted; "yes" means the domain is deleted.
    fwd_host_type String Back-to-origin configuration type: "default" means the connected domain is the address for back-to-origin requests; "custom" means the domain uses customized address for back-to-origin requests.
    fwd_host String Address for back-to-origin requests
    middle_resource Int Configuration of intermediate node: "-1" means the domain has closed intermediate node services; "0" means the domain has activated intermediate node services.
    refer Array Hotlink protection configuration, as described below
    cname String The accelerated domain with ".cdn.dnsv1.com" as suffix assigned by CDN
    cache_mode String Type of caching rules: "simple" means cache completely depends on the Console; "custom" means cache depends on the cache expiration time set by the Console and the minimum value in max-age set by origin server.
    furl_cache String Filter parameter: "on" means to enable; "off" means to disable
    ssl_type Int Indicate whether to activate HTTPS: "0" means HTTPS configuration is not activated; others means HTTPS configuration is activated.
    bucket_name String bucket name corresponding to the COS origin
    ssl_deploy_time String SSL deploying time
    ssl_expire_time String SSL expiration time
    seo String Indicate whether to enable SEO optimization: "off" means to disable; "on" means to enable
    host_id Int Host ID, same as id

    cache Field Description

    Parameter Name Type Description
    type Int Type. There are four types: 0 refers to all files, 1 refers to file type, 2 refers to folder type, and 3 refers to full-path file
    rule String Matching rule, corresponding to the types above
    time Int Cache expiration time (in seconds)
    unit String The unit used to set cache expiration time. There are four types: "d" refers to day, "h" refers to hour, "m" refers to minute, and "s" refers to second

    refer Field Description

    Parameter Name Type Description
    type Int Hotlink protection type. There are three types: 0 means that hotlink protection is not configured, 1 means that the configured list is a blacklist, 2 means that the configured list is a whitelist
    null_flag Int Indicate whether the hotlink protection is empty. 1 means the hotlink protection is empty
    list Array The configured hotlink protection list

    Note:

    • The fields not described in the above are invalid fields, which can be ignored directly.

    4. Example

    4.1 Example of Input

    offset: 0
    limit: 10

    4.2 GET Request

    All the parameters are required to be added after URL in GET request:

    https://cdn.api.qcloud.com/v2/index.php?
    Action=DescribeCdnHosts
    &SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
    &Timestamp=1462434006
    &Nonce=123456789
    &Signature=XXXXXXXXXXXXXXXXXXXXX
    &offset=0
    &limit=10

    4.3 POST Request

    In POST request, the parameters will be filled in HTTP Request-body. The request address is:

    https://cdn.api.qcloud.com/v2/index.php

    Such formats of parameters as form-data, x-www-form-urlencoded are supported. The array of parameters is as follows:

    array (
      'Action' => 'DescribeCdnHosts',
      'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
      'Timestamp' => 1462782282,
      'Nonce' => 123456789,
      'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
      'offset' => '0',
      "limit" => '10'
    )

    4.4 Example of Returned Result

    Query Successful

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "data": {
            "hosts": [
                {
                    "id": 308902,
                    "app_id": 1234567,
                    "owner_uin": 7654321,
                    "project_id": 0,
                    "host": "www.test.com",
                    "host_type": "cname",
                    "service_type": "web",
                    "origin": "8.8.8.8",
                    "cache": [
                        {
                            "type": 0,
                            "rule": "all",
                            "time": 2592000,
                            "unit": "d"
                        },
                        {
                            "type": 1,
                            "rule": ".php;.jsp;.asp;.aspx",
                            "time": 0,
                            "unit": "s"
                        }
                    ],
                    "status": 5,
                    "disabled": 0,
                    "message": "Activated",
                    "enable_overseas": "no",
                    "create_time": "2016-08-25 21:22:40",
                    "update_time": "2016-09-02 15:33:37",
                    "deleted": "no",
                    "fwd_host_type": "default",
                    "fwd_host": "www.test.com",
                    "middle_resource": -1,
                    "refer": {
                        "type": 2,
                        "list": [
                            "1.1.1.1"
                        ],
                        "null_flag": 0
                    },
                    "readonly": 0,
                    "cname": "www.test.com.cdn.dnsv1.com",
                    "cache_mode": "simple",
                    "furl_cache": "on",
                    "ssl_type": 0,
                    "pid_config": null,
                    "bucket_name": "",
                    "bucket_project_id": 0,
                    "ssl_deploy_time": null,
                    "ssl_expire_time": null,
                    "seo": "off",
                    "host_id": 308902
                }
            ],
            "total": 1
        }
    }

    Query Failed

    {
        "code": 4100,
        "message": "Authentication failed. Please refer to the Authentication section in the document.",
        "codeDesc": "AuthFailure"
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help