域名管理¶
POST 查询域名列表 tcdn:domain:query¶
POST /prod-api/acdn/tcdn/domainRest/describeDomains
Body 请求参数
请求参数¶
| 名称 | 位置 | 类型 | 必选 | 中文名 | 说明 |
|---|---|---|---|---|---|
| Authorization | header | string | 是 | none | |
| body | body | object | 否 | none | |
| » country | body | string | 否 | none | |
| » filters | body | [object] | 否 | 搜索条件 | none |
| »» label | body | string | 否 | 参数名 | none |
| »» value | body | [string] | 否 | 值 | 数组类型,传入单个值为模糊搜索,多个值为精确搜索 |
| » pageNum | body | integer(int32) | 是 | 当前页数 | none |
| » pageSize | body | integer(int32) | 是 | 每页显示条目个数 | none |
| » searchHeader | body | object | 否 | 筛选 | none |
| »» status | body | string | 是 | 状态 | online:表示启动 |
| »» area | body | string | 是 | 加速区域 | mainland:表示中国境内 |
| »» serviceType | body | string | 是 | 加速类型 | web:表示网页 |
详细说明¶
»» status: online:表示启动 offline:表示已关闭 deleted:表示删除 closing:表示关闭中 processing:表示部署中
»» area: mainland:表示中国境内 overseas:表示中国境外 global:表示全球
»» serviceType: web:表示网页 download:表示下载 media:表示点播
返回示例
200 Response
{
"total": 2,
"rows": [
{
"resourceId": "cdn-h9odj4uu",
"appId": 1370897931,
"domain": "lw111.demo.com",
"cname": "",
"status": "offline",
"projectId": 1000006311,
"serviceType": "web",
"createTime": "2025-09-03 14:34:46",
"updateTime": "2025-09-03 14:42:35",
"origin": {
"header": {},
"skipSign": false,
"basePath": null,
"serverName": "lw111.demoq.com",
"origins": ["1.1.1.1"],
"originType": "ip",
"cosPrivateAccess": "off",
"originPullProtocol": "http",
"backupOriginType": null,
"backupServerName": null,
"advanceHttps": {
"header": {},
"skipSign": false,
"certInfo": null,
"verifyOriginType": "off",
"customTlsStatus": "off",
"cipher": "DEFAULT",
"originCertInfo": null,
"tlsVersion": ["TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3"],
"stream": false
},
"backupOrigins": [],
"pathRules": [],
"pathBasedOrigin": [],
"sni": {
"header": {},
"skipSign": false,
"serverName": null,
"switch": "off",
"stream": false
},
"originCompany": null,
"stream": false
},
"disable": "normal",
"area": "mainland",
"readonly": "normal",
"product": "cdn",
"parentHost": "",
"oid": "202505271234561329409"
},
{
"resourceId": "cdn-cdy0ues3",
"appId": 1370897931,
"domain": "zz.demo.com",
"cname": "",
"status": "offline",
"projectId": 1000006311,
"serviceType": "web",
"createTime": "2025-07-25 11:11:23",
"updateTime": "2025-09-03 14:42:38",
"origin": {
"header": {},
"skipSign": false,
"basePath": null,
"serverName": "zz.demo.com",
"origins": ["1.1.1.1"],
"originType": "ip",
"cosPrivateAccess": "off",
"originPullProtocol": "http",
"backupOriginType": null,
"backupServerName": null,
"advanceHttps": {
"header": {},
"skipSign": false,
"certInfo": null,
"verifyOriginType": "off",
"customTlsStatus": "off",
"cipher": "DEFAULT",
"originCertInfo": null,
"tlsVersion": ["TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3"],
"stream": false
},
"backupOrigins": [],
"pathRules": [],
"pathBasedOrigin": [],
"sni": {
"header": {},
"skipSign": false,
"serverName": null,
"switch": "off",
"stream": false
},
"originCompany": null,
"stream": false
},
"disable": "normal",
"area": "mainland",
"readonly": "normal",
"product": "cdn",
"parentHost": "",
"oid": "2025052727912345629409"
}
],
"code": 0,
"msg": "success"
}
201 Response
返回结果¶
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | none | Inline |
| 201 | Created | none | Inline |
| 401 | Unauthorized | none | Inline |
| 403 | Forbidden | none | Inline |
| 404 | Not Found | none | Inline |
返回数据结构¶
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| » total | integer | true | none | none | |
| » rows | [object] | true | none | none | |
| »» resourceId | string | true | none | none | |
| »» appId | integer | true | none | none | |
| »» domain | string | true | none | 域名 | none |
| »» cname | string | true | none | CNAME | none |
| »» status | string | true | none | 状态 | online:表示启动 offline:表示已关闭 deleted:表示删除 closing:表示关闭中 processing:表示部署中 |
| »» projectId | integer | true | none | none | |
| »» serviceType | string | true | none | 加速类型 | web:表示网页 download:表示下载 media:表示点播 |
| »» createTime | string | true | none | 创建时间 | none |
| »» updateTime | string | true | none | 更新时间 | none |
| »» origin | object | true | none | 源 | none |
| »»» header | object | true | none | none | |
| »»» skipSign | boolean | true | none | none | |
| »»» basePath | null | true | none | none | |
| »»» serverName | string | true | none | none | |
| »»» origins | [string] | true | none | none | |
| »»» originType | string | true | none | none | |
| »»» cosPrivateAccess | string | true | none | none | |
| »»» originPullProtocol | string | true | none | none | |
| »»» backupOriginType | null | true | none | none | |
| »»» backupServerName | null | true | none | none | |
| »»» advanceHttps | object | true | none | none | |
| »»»» header | object | true | none | none | |
| »»»» skipSign | boolean | true | none | none | |
| »»»» certInfo | null | true | none | none | |
| »»»» verifyOriginType | string | true | none | none | |
| »»»» customTlsStatus | string | true | none | none | |
| »»»» cipher | string | true | none | none | |
| »»»» originCertInfo | null | true | none | none | |
| »»»» tlsVersion | [string] | true | none | none | |
| »»»» stream | boolean | true | none | none | |
| »»» backupOrigins | [string] | true | none | none | |
| »»» pathRules | [string] | true | none | none | |
| »»» pathBasedOrigin | [string] | true | none | none | |
| »»» sni | object | true | none | none | |
| »»»» header | object | true | none | none | |
| »»»» skipSign | boolean | true | none | none | |
| »»»» serverName | null | true | none | none | |
| »»»» switch | string | true | none | none | |
| »»»» stream | boolean | true | none | none | |
| »»» originCompany | null | true | none | none | |
| »»» stream | boolean | true | none | none | |
| »» disable | string | true | none | none | |
| »» area | string | true | none | 加速区域 | mainland:表示中国境内 overseas:表示中国境外 global:表示全球 |
| »» readonly | string | true | none | none | |
| »» product | string | true | none | none | |
| »» parentHost | string | true | none | none | |
| »» oid | string | true | none | 套餐 | none |
| » code | integer | true | none | none | |
| » msg | string | true | none | none |
数据模型¶
TCDNDescribeDomainsReqVO
{
"country": "string",
"filters": [
{
"label": "string",
"value": ["string"]
}
],
"pageNum": 0,
"pageSize": 0,
"params": {},
"searchHeader": {},
"searchValue": "string",
"tableCul": {
"property1": "string",
"property2": "string"
},
"userId": 0
}
TCDNDescribeDomainsReqVO
属性¶
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| country | string | false | none | none | |
| filters | [object] | false | none | 搜索条件 | none |
| » label | string | false | none | 参数名 | none |
| » value | [string] | false | none | 值 | 数组类型,传入单个值为模糊搜索,多个值为精确搜索 |
| pageNum | integer(int32) | true | none | 当前页数 | none |
| pageSize | integer(int32) | true | 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 |