全部產品
Search

搜尋本產品

    API Gateway：CreateHttpApi - 建立HTTP API

    文件中心

    API Gateway：CreateHttpApi - 建立HTTP API

    更新時間：Mar 30, 2026

    建立一個HTTP類型的API。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    apig:CreateHttpApi

    create

    *HttpApi

    acs:apig:{#regionId}:{#accountId}:httpapi/*

    		 無 無

    請求文法

    POST /v1/http-apis HTTP/1.1

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    body

    object

    否

    建立 API 相關參數。

    name

    string

    是

    API 名稱。

    test-api
    description

    string

    否

    API 描述。

    測試專用API。
    protocols

    array

    否

    API 訪問協議列表。

    string

    否

    API 訪問協議。

    HTTP
    basePath

    string

    否

    API 基礎路徑，需要以/開頭。

    /v1
    versionConfig HttpApiVersionConfig

    否

    API 版本化配置。

    type

    string

    否

    HTTP API 的類型。

    • Http

    • Rest

    • WebSocket

    • HttpIngress

    • LLM

    • Agent

    枚舉值：

    • HttpIngress :

      HttpIngress

    • Agent :

      Agent

    • Rest :

      Rest

    • Http :

      Http

    • LLM :

      LLM

    • WebSocket :

      WebSocket

    Http
    ingressConfig

    object

    否

    HTTP Ingress API 配置資訊。

    environmentId

    string

    否

    環境 ID。

    env-cq146allhtgk***
    sourceId deprecated

    string

    否

    來源 ID。

    src-crdddallhtgtr***
    ingressClass

    string

    否

    監聽的 Ingress Class。

    mse
    watchNamespace

    string

    否

    監聽的命名空間。

    default
    overrideIngressIp

    boolean

    否

    是否更新 Ingress Status 裡的地址。

    false
    clusterId

    string

    否

    叢集 ID。

    k7v5eobfzttudni2pw***
    resourceGroupId

    string

    否

    資源群組 ID。

    rg-xxx
    aiProtocols

    array

    否

    AI API 協議，當前支援協議列表如下：

    • OpenAI/v1

    string

    否

    AI API 協議。

    OpenAI/v1
    agentProtocols

    array

    否

    代理支援的協議列表

    string

    否

    代理支援的協議列表

    http/https
    deployConfigs

    array

    否

    API 部署配置，當前僅 AI API 支援部署配置，且僅支援傳遞單個部署配置。

    HttpApiDeployConfig

    否

    API 部署配置。

    enableAuth

    boolean

    否

    是否開啟許可權認證

    true
    authConfig AuthConfig

    否

    許可權認證配置

    modelCategory

    string

    否

    模型類別

    llm/text-to-image
    removeBasePathOnForward

    boolean

    否

    轉寄請求時是否移除基礎路徑

    true
    firstByteTimeout

    integer

    否

    等待後端返回首個位元組的逾時時間

    30
    belongGatewayId

    string

    否

    所屬網關 ID

    gw-abc123xyz789
    dryRun deprecated

    boolean

    否

    是否僅預覽不執行

    true
    strategy

    string

    否

    匯入的衝突合并策略

    ExistFirst

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    響應體。

    requestId

    string

    請求 ID。

    A1994B10-C6A8-58FA-8347-6A08B0D4EFDE
    code

    string

    狀態代碼。

    Ok
    message

    string

    響應訊息。

    success
    data

    object

    API 資訊。

    httpApiId

    string

    HTTP API ID。

    api-xxx
    name

    string

    API 名稱。

    test-api

    樣本

    正常返回樣本

    JSON格式

    {
  "requestId": "A1994B10-C6A8-58FA-8347-6A08B0D4EFDE",
  "code": "Ok",
  "message": "success",
  "data": {
    "httpApiId": "api-xxx",
    "name": "test-api"
  }
}

    錯誤碼

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

    變更歷史

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