接口功能介紹
更新自定義域名
接口約束
無
URI
PUT /openapi/v1/domains/customdomains/*
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| domainName | 是 | String | 域名 | | |
Query參數
無
請求參數
請求頭header參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| regionId | 是 | String | 資源池id | test | |
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| authConfig | 是 | Object | 認證配置信息 | | AuthConfig |
| certConfig | 否 | Object | HTTPS證書的信息 | | CERTConfig |
| description | 否 | String | 自定義描述 | - | - |
| domainName | 是 | String | 自定義域名名稱(已備案或接入備案) | example.com | - |
| protocol | 否 | String | 域名支持的協議類型:HTTP, HTTPS, HTTP,HTTPS | HTTPS | - |
| routeConfig | 否 | Object | 自定義域名訪問時的PATH到Function映射 | | RouteConfig |
| 表 AuthConfig | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| authType | 是 | String | 認證類型:anonymous|jwt | jwt | - |
| jwtConfig | 否 | Object | jwt 認證配置 | | JwtConfig |
| 表 JwtConfig | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| claimTrans | 是 | Array of Objects | JWT 的 claim 映射到請求的某個位置 | | ClaimTran |
| jwks | 是 | String | 包含一個或多個 JWK 的 JSON 字符串 | - | - |
| tokenConfig | 是 | Array of Objects | token 解析的相關配置 | | TokenConfig |
| 表 ClaimTran | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| claimName | 是 | String | 要進行映射的 claim 字段 | user | - |
| targetName | 是 | String | 映射后的字段名 | username | - |
| transLocation | 是 | String | 映射到請求的位置:Header | Header | - |
| 表 TokenConfig | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| location | 是 | String | token 讀取的位置:Cookie, Header, Query | Header | - |
| name | 是 | String | token 在讀取位置對應的字段名 | Authorization | - |
| removePrefix | 否 | String | token 需要去除的前綴(僅讀取位置為 Header 時使用) | Bearer | - |
| 表 CERTConfig | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| certificate | 是 | String | HTTPS證書內容 | - | - |
| certName | 是 | String | 證書的名稱 | my-cert | - |
| privateKey | 是 | String | 證書私鑰內容 | - | - |
| 表 RouteConfig | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| routes | 否 | Array of Objects | 路由規則列表 | | PathConfig |
| 表 PathConfig | | | | | |
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| enableJwt | 是 | Integer | 是否開啟 JWT 認證:0:不開;1:開啟 | 1 | - |
| functionId | 是 | Integer | 路由規則對應的函數 ID | 12345 | - |
| functionName | 是 | String | 路由規則對應的函數名稱 | my-function | - |
| functionUniqueName | 是 | String | 函數的唯一名稱 | my-function-unique | - |
| path | 是 | String | 路由規則對應的請求路徑 | /api/path, 支持后綴統配符*,例如/api/* | - |
| qualifier | 否 | String | 路由規則對應的函數版本或別名或LATEST | 1、prod、LATEAT | - |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| statusCode | Integer | 狀態碼,0表示成功,非0表示不成功 | 0 | |
| error | String | 錯誤碼 | CF_0 | |
| message | String | 信息 | | |
| returnObj | Object | 返回實體 | | ReturnObj |
| 表 ReturnObj | | | | |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|
| 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 | Object | 認證類型 | | |
| 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/example.com
請求頭header
無
請求體body
{
"domainName": "test.mzychaco.email",
"protocol": "HTTP",
"routeConfig": {
"routes": [
{
"functionName": "funca-yppopcjasv",
"path": "/you/path",
"qualifier": "LATEST"
}
]
},
"certConfig": {
"certName": "",
"certificate": "",
"privateKey": ""
},
"authConfig": {
"authType": "anonymous"
}
}
響應示例
{
"statusCode": 0,
"message": "",
"returnObj": {
"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
}
}
狀態碼
請參考
錯誤碼
請參考