Query Configuration Information of Domain

Last updated: 2020-06-05 20:22:02

    Note:

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

    API Description

    This API (GetDsaHostList) is used to query the list of all DSA accelerated domain names under the account.
    Domain name for API request: dsa.api.qcloud.com

    This API can be called up to 100 times per minute.

    Input Parameters

    The following request parameter list only provides API request parameters. Common request parameters are required when the API is called.

    Parameter Name Required Type Description
    offset No Unsigned Offset. Default is 0, which means no offset.
    length No Unsigned The maximum number of entries returned. Default is 3,000 (the max value)
    includeDeleted No Int Indicates whether deleted domain names are included. 0: Not included (default)

    Note

    This API supports querying the information of up to 3,000 domain names at a time.
    If there are a large number of domain names, you can use "offset" and "length" for paged queries.

    Output Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Successful; other values: Failed.
    message String Module error message description depending on API
    codeDesc String Error message or error code.
    data Object Returned result as described below

    data Field Description

    Parameter Name Type Description
    hosts Object Details of the domain name as described below in hosts Field Description
    total Int Total number of domain names under the account

    hosts Field Description

    Parameter Name Type Description
    host_id Int ID of the domain name connected to DSA
    app_id Int APPID of domain name owner
    project_id Unsigned ID of project to which the domain name belongs
    host String Accelerated domain name
    cname String Cname of the domain name after it is connected to DSA
    status String The current status of the domain name. online: Activated; offline: Deactivated
    process Int Configuration deployment status. 0: Deployed; 1: Deploying
    mode Int Indicates whether the domain name is blocked; "0" indicates that the domain name is not blocked
    locked Int Indicates whether the OPS service is locked. 0: Unlocked, which means you can directly modify the configuration; 1: Locked, which means you need to submit a ticket for configuration modification
    deleted Int Indicates whether the configuration has been deleted. 0: Not deleted; 1: Deleted
    message String Message description

    Example

    1. Configuration example

    Obtain the list of all domain names under this account.

    2. GET request

    https://dsa.api.qcloud.com/v2/index.php?
    Action=GetDsaHostList   
    &SecretId=XXXXXXXXXXXXXXXXXXXXXXXXX   
    &Timestamp=1462440051   
    &Nonce=123456789   
    &Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX 
    &offset=0
    &length=2048 
    &includeDeleted=1

    3. POST request

    For a POST request, the parameters are input in HTTP Request-body. The request address is:

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

    Formats such as form-data and x-www-form-urlencoded are supported for the parameters. The array of parameters is as follows:

    array (
      'Action' => 'GetDsaHostList',
      'SecretId' => 'SecretId',
      'Timestamp' => 1462782282,
      'Nonce' => 123456789,
      'Signature' => 'Signature',
      'offset' => '0',
      'length' => '2048', 
      'includeDeleted' => '1'
    )

    4 Example of Reponse

    Query Successful

    {
        "code": 0,
        "message": "",
        "codeDesc": "Success",
        "data": {
            "hosts": [
                {
                     "host_id": XXXX,
                    "app_id": XXXXXXXX,
                    "project_id": 0,
                    "host": "dsatest.qcloud.com",
                    "cname": "dsatest.qcloud.com.dsa.dnsv1.com",
                    "status": "online",
                    "deleted": 0,
                    "message": ""
                },
                {
                    "host_id": XXXX,
                    "app_id": XXXXXXXX,
                    "project_id": 0,
                    "host": "dsatest2.qcloud.com",
                    "cname": "dsatest2.qcloud.com.dsa.dnsv1.com",
                    "status": "offline",
                    "deleted": 0,
                    "message": ""
                }
            ],
            "total": 2
        }
    }

    Query Failed

    {
        "code": 4100,
        "message": "Authentication failed. For more information, please see 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