Skip to content

Domain Basic Information Interface

POST Domain List

POST /cdn/domain/list

Get domain list

Body request parameters

{
  "filters": [
    {
      "label": "oid",
      "value": ["2022082123456"]
    }
  ],
  "searchHeader": {
    "isActive": ["0"]
  },
  "pageSize": 10,
  "pageNum": 1
}

Request Parameters

Name Location Type Required Chinese Name Description
Authorization header string No none
body body object No none
» country body string No none
» domainId body integer(int64) No none
» filters body [object] Yes Search conditions none
»» label body string Yes Parameter name none
»» value body [string] Yes Value Array type, single value for fuzzy search, multiple values for exact search
» pageNum body integer(int32) No none
» pageSize body integer(int32) No none
» params body object No none
» searchHeader body object Yes Filter Domain/Port/Package (alias)/Remark: domainName/port/doid/customerRemark
»» isActive body [string] Yes 0：Configuring
» searchValue body string No none
» tableCul body object No none
»» additionalProperties body string No none

Detailed Description ​​»» isActive​​: 0: Configuring 1: Active/Deploying 2: Paused

Response Example

200 Response

{
  "total": 30,
  "rows": [
    {
      "id": 211,
      "sslsupport": "0",
      "domainName": "demo.com",
      "ip": "1.1.1.1\n2.2.2.2",
      "port": "0",
      "cNamePre": "demo.com",
      "cNameSuf": "",
      "doid": "202208212345608922",
      "isActive": "0",
      "customerRemark": "",
      "alias": "11123",
      "coreId": "207",
      "waf": "0",
      "stopTime": "0",
      "updateTime": "1704693635",
      "certEndTime": null,
      "wafInternalRulesList": null
    }
  ],
  "code": 200,
  "msg": "Query successful"
}

201 Response

{}

Response Results

Status Code Status Code Meaning Description Data Model
200 OK none Inline
201 Created none Inline
401 Unauthorized none Inline
403 Forbidden none Inline
404 Not Found none Inline

返回数据结构

状态码 200

Name Type Required Constraints Chinese Name Description
» total integer true none Total count none
» rows [object] true none none
»» id integer false none none
»» sslsupport string false none SSL configured 1：SSL configured
»» domainName string false none Domain name none
»» ip string false none Origin address none
»» port string false none Port none
»» cNamePre string false none cNamePre none
»» cNameSuf string false none cNameSuf none
»» doid string false none Package none
»» isActive string false none Status 0：Configuring
1：Active/Deploying
2：Paused
»» customerRemark string false none Remark none
»» alias string false none Alias none
»» coreId string false none none
»» waf string false none none
»» stopTime string false none none
»» updateTime string false none Creation time none
»» wafInternalRulesList null false none none
» code integer true none none
» msg string true none none

Data Models

QueryDomainListVO

{
  "country": "string",
  "domainId": 0,
  "filters": [
    {
      "label": "string",
      "value": ["string"]
    }
  ],
  "pageNum": 0,
  "pageSize": 0,
  "params": {},
  "searchHeader": {},
  "searchValue": "string",
  "tableCul": {
    "property1": "string",
    "property2": "string"
  },
  "userId": 0
}

QueryDomainListVO

Properties

Name Type Required Constraints Chinese Name Description
country string false none none
domainId integer(int64) false none none
filters [SearchFilterVo] false none none
pageNum integer(int32) false none none
pageSize integer(int32) false none none
params object false none none
searchHeader object false none none
searchValue string false none none
tableCul object false none none
» additionalProperties string false none none
userId integer(int64) false none none

SearchFilterVo

{
  "label": "string",
  "value": ["string"]
}

SearchFilterVo

Properties

Name Type Required Constraints Chinese Name Description
label string false none none
value [string] false none none