Development Document

View Domain List Download PDF Document

Endpoint

Request URL: domain/list (GET)

Endpoint Domain Name: cdn.api.baishan.com
Endpoint Version: v2

Endpoint Description

Look up domain name list and return the basic information of domain names.

Notice: See the Response Header for the frequency limit.

API Parameters

Notice: Please request the API token from your account team.

Request Parameters (GET)

Specify request parameters in the URL query strings, i.e. ?key1=value1&key2=value2.

ParameterData TypeRequirementDescription
page_numberintOptionalPage number. The default is 1.
page_sizeintOptionalNumber of pages. Select from range 1-500. The default is 100.
domain_statusstringOptionalDomain types separated by commas. Options are deleted, suspend, serving.. For example, domain_status=suspend, serving. If the parameter is not specified, domains of all types are returned. Note that when looking for domain_status=serving, the response could be “deploying”, which means the domain name’s configuration is currently being deployed. deleted, suspend, serving domain_status=suspend,serving

Sample Request:

curl -X GET
"https://cdn.api.baishan.com/v2/domain/list?token=xxx&page_number=1&page_size=50&domain_status=suspend,serving"

Sample Response

Json format.

{
    "code": 0, //0 means data response normal; if code non 0 means the response is unnormal
    "data": {
        "list": [
            {
                "id": "4612392",
                "domain": "www.aa.com",//domain name
                "type": "page",//domain name type (page| download| video_demand|dynamic)
                "status": "suspend",
                "cname": "aa.com.qingcdn.com.",
                "icp_status": "yes",//icp status(checking=Searching, yes=Registered, no=non-Registered)
                "icp_num": "蜀ICP备93014234号-2",//icp number
                
                "config": {
                    //origin configuration
                    "origin": {
                        "default_master": "1.1.1.1",//Origin IP
                        "origin_mode": "default",//Origin mode
                        "ori_https": "no",//Required ttps
                        "port": ""//Port going back to the origin, defult 80
                    }
                }
            },
            {
                "id": "4612393",
                "domain": "www.bb.com",
                "type": "page",
                "status": "serving",
                "cname": "bb.com.qingcdn.com.",
                "icp_status": "yes",
                "icp_num": "蜀ICP备93014233号-1",
                "config": {
                    "origin": {
                        "default_master": "22.22.22.22",
                        "origin_mode": "https",//Origin mode
                        "ori_https": "yes",//Reqiremwnt of https
                        "port": "443",//Port going back to the origin, defult 80
                        "dx_master": "1.2.1.2"
                    }
                }
            },
        ],
        "page_size": 100, //Page size
        "page_number": "1", //Page number
        "total_number": "33960" //Total number
    }
}

Response Header

HTTP/1.0 200 OK
Api-Id:                112006099
Content-Type:          application/json; charset=utf-8
X-Ratelimit-Grad:      minute
X-Ratelimit-Limit:     300
X-Ratelimit-Remaining: 300
X-Retry-After:         53

HTTP Status Codes

Error CodeDescription
404Bad request URLs.
401Authorization Error: Invalid token or lack of access.
400Bad request parameters.
200Success.
5xxPlease contact your account team.
CopyRight © 2015-2022 BaishanCloud . All Rights Reserved.