全部產品
Search

搜尋本產品

    API Gateway：SetDomain - 給指定分組綁定自訂網域名

    文件中心

    API Gateway：SetDomain - 給指定分組綁定自訂網域名

    更新時間：Dec 24, 2025

    給指定API分組綁定自訂網域名。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    apigateway:SetDomain

    update

    *ApiGroup

    acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    GroupId

    string

    是

    API 分組 ID，系統產生，全域唯一

    927d50c0f2e54b359919923d908bb015
    DomainName

    string

    是

    自訂網域名

    api.demo.com
    BindStageName

    string

    否

    網域名稱要指定環境訪問。不設定該值，則表示該網域名稱能訪問所有環境。

    如果指定了某個具體的環境，則該網域名稱只能訪問這個環境。 可選值：

    • TEST

    • PRE

    • RELEASE

    當要修改為全部環境都可訪問時，則將該值設定為空白串（“”）即可。

    RELEASE
    CustomDomainType

    string

    否

    指定網域名稱要綁定的類型：公網或者內網。預設為 INTERNET。可選值：

    • INTERNET：公網類型

    • INTRANET：內網類型, 當指定了內網類型後，就不允許該網域名稱從公網請求過來。

    INTERNET
    IsForce

    boolean

    否

    該欄位用於當網域名稱衝突時，是否強制綁定該網域名稱。如果選擇 true，則會強制在該分組綁定此網域名稱，另外衝突的分組上的網域名稱會自動解除綁定。該操作有一定風險，請謹慎操作。

    false
    IsHttpRedirectToHttps

    boolean

    否

    是否將 http 重新導向到 https

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求唯一標識

    0AA90E87-3506-5AA6-AFFB-A4D53B4F6231
    DomainLegalStatus

    string

    網域名稱合法狀態，取值：

    • NORMAL：正常

    • ABNORMAL：異常，該狀態會影響 API 呼叫，需儘快解決

    NORMAL
    GroupId

    string

    API 分組 ID，系統產生，全域唯一

    927d50c0f2e54b359919923d908bb015
    SubDomain

    string

    系統給分組綁定的次層網域，用於測試 API 呼叫

    xxx-cn-hangzhou.alicloudapi.com
    DomainName

    string

    自訂網域名

    api.demo.com
    DomainBindingStatus

    string

    自訂網域名綁定狀態

    • BINDING：正常

    • BOUND：未生效

    BINDING
    DomainRemark

    string

    網域名稱相關備忘，如描述網域名稱異常狀態原因

    無
    DomainWebSocketStatus

    string

    使用 WebSocket 功能的網域名稱狀態

    NORMAL

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "0AA90E87-3506-5AA6-AFFB-A4D53B4F6231",
  "DomainLegalStatus": "NORMAL",
  "GroupId": "927d50c0f2e54b359919923d908bb015",
  "SubDomain": "xxx-cn-hangzhou.alicloudapi.com",
  "DomainName": "api.demo.com",
  "DomainBindingStatus": "BINDING",
  "DomainRemark": "無",
  "DomainWebSocketStatus": "NORMAL"
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。