獲取自定義域名列表
更新時間 2025-10-20 10:51:13
最近更新時間: 2025-10-20 10:51:13
分享文章
接口功能介紹
獲取自定義域名列表
接口約束
無
URI
GET /openapi/v1/domains/customdomains
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| pageIndex | 否 | Integer | 頁碼,默認為-1 | 0 | |
| pageSize | 否 | Integer | 每頁大小,默認為-1 | 0 | |
| searchKey | 否 | String | 模糊查詢的關鍵字,默認為空 |
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池id | test |
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼,0表示成功,非0表示不成功 | 0 | |
| error | String | 錯誤碼 | CF_0 | |
| message | String | 信息 | ||
| returnObj | Object | 返回實體 | ReturnObj | |
| 表 ReturnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| data | Array of Objects | 分頁數據 | Data | |
| pagination | Object | 分頁信息 | Pagination | |
| 表 Pagination |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| pageIndex | Integer | 頁碼 | ||
| pageSize | Integer | 每頁大小 | ||
| total | Integer | 總記錄數 | ||
| 表 Data |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| createdAt | String | 創建時間 | 2024-10-08T15:35:41.427170734+08:00 | |
| updatedAt | String | 更新時間 | 2024-10-08T15:35:41.623015323+08:00 | |
| creator | Integer | 創建者ID | 17250 | |
| editor | Integer | 編輯者ID | 17250 | |
| certConfig | Object | HTTPS證書信息 | CERTConfig | |
| domainName | String | 自定義域名 | mozy.mzychaco.email | |
| protocol | String | 協議類型 | HTTP | |
| routeConfig | Object | 路由表 | RouteConfig | |
| authConfig | Object | 認證配置 | AuthConfig | |
| domainStatus | String | 域名備案狀態 | 0 | |
| filingStatus | Object | 域名備案詳細信息 | FilingStatus | |
| description | String | 描述 | ||
| cnameValid | Boolean | CNAME是否有效,僅在應用場景下有意義 | false | |
| 表 CERTConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| certificate | String | 證書 | ||
| certName | String | 證書名稱 | ||
| privateKey | String | 私鑰 | ||
| 表 RouteConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| routes | Array of Objects | 路由映射 | PathConfig | |
| 表 PathConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| enableJwt | Integer | 是否啟用JWT | 0 | |
| functionId | Integer | 函數ID | 2807999806632073 | |
| functionName | String | 函數名稱 | ccc | |
| functionUniqueName | String | 函數唯一名稱 | ccc-sykqwhnjwu | |
| methods | Array of Strings | 請求方法 | [] | |
| path | String | 請求路徑 | /* | |
| qualifier | String | 函數版本 | 2 | |
| 表 AuthConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| authType | String | 認證類型 | anonymous | |
| jwtConfig | Object | JWT配置 | JwtConfig | |
| 表 JwtConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| jwks | String | JWK字符串 | ||
| tokenConfig | Array of Objects | Token配置 | TokenConfig | |
| matchMode | Object | JWT匹配模式,固定為All | MatchMode | |
| 表 TokenConfig |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| location | String | Token讀取位置 | ||
| name | String | 字段名 | ||
| 表 MatchMode |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| mode | String | 匹配模式 | All | |
| path | Array of Strings | 匹配路徑 | [] | |
| 表 FilingStatus |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| domain | String | 一級域名 | mzychaco.email | |
| recordStatus | String | 備案狀態,0:未備案 1:已備案 | 0 | |
| recordNumber | String | 備案號 | - | |
| errMessage | String | 異常信息 |
枚舉參數
無
請求示例
請求url
//{host}/openapi/v1/domains/customdomains?pageIndex=1&pageSize=10
請求頭header
無
請求體body
無
響應示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"data": [{
"createdAt": "2024-10-08T19:59:25.869382+08:00",
"updatedAt": "2024-10-08T19:59:26.792778+08:00",
"creator": 82647,
"editor": 82647,
"certConfig": {
"certificate": "",
"certName": "",
"privateKey": ""
},
"domainName": "example.com",
"protocol": "HTTP",
"routeConfig": {
"routes": [
{
"functionName": "funcA",
"functionUniqueName": "funca-yppopcjasv",
"functionId": 266,
"path": "/you/path",
"qualifier": "LATEST",
"rewriteConfig": {
"regexRules": null,
"wildcardRules": null
},
"enableJwt": 0
}
]
},
"authConfig": {
"authType": "anonymous"
},
"domainStatus": "",
"filingStatus": {
"domain": "",
"recordStatus": "",
"recordNumber": "",
"errMessage": "domain check is close"
},
"description": "",
"cnameValid": false
}],
"pagination": {
"pageIndex": 1,
"pageSize": 10,
"total": 1
}
}
}
狀態碼
請參考
錯誤碼
請參考