全部產品
Search
文件中心

API Gateway:CreateApiGroup - 建立API分組

更新時間:Dec 24, 2025

建立API分組。

介面說明

建立 API 需要先建立分組,所屬分組是 API 的一個基本屬性資訊。

  • 此功能面向 API 提供者。

  • 每個使用者每個地區下最多可建立 100 個分組。

  • 系統自動給分組分配次層網域,用於測試 API。

  • 分組帶有地區屬性,後續建立 API 選擇分組後就選擇了地區,為減少網路延時,建議選擇與後端服務相同的地區。

  • 建立分組後,可為分組綁定已備案的自訂網域名。

  • 該介面調用的 QPS 限制為:單使用者 QPS 不超過 50。

調試

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

調試

授權資訊

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

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

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

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

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

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

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

apigateway:CreateApiGroup

create

*ApiGroup

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

請求參數

名稱

類型

必填

描述

樣本值

GroupName

string

分組名稱,必須唯一,支援漢字、英文字母、數字、英文格式的底線,必須以英文字母或漢字開頭,4~50 個字元。

Weather

BasePath

string

api 根路徑

/qqq

Description

string

API 分組描述,不超過 180 個字元。

The weather informations.

InstanceId

string

執行個體 ID

apigateway-cn-v6419k43xxxxx

Tag

array<object>

指定規則所適用的對象標籤,可設定多個。

Key, Value

object

Key

string

標籤的 key

key

Value

string

標籤的 value

value

返回參數

名稱

類型

描述

樣本值

object

TagStatus

boolean

標籤是否存在,取值:-true:存在-false:不存在

True

BasePath

string

api 根路徑

/qqq

RequestId

string

請求唯一標識

FF3B7D81-66AE-47E0-BF69-157DCF187514

Description

string

API 分組描述

The weather informations

GroupName

string

API 分組名稱

Weather

GroupId

string

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

523e8dc7bbe04613b5b1d726c2a7xx

InstanceId

string

執行個體 ID

apigateway-cn-v6419k43xxxxx

SubDomain

string

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

523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com

InstanceType

string

執行個體類型

  • CLASSIC_SHARED:共用執行個體傳統網路

  • VPC_SHARED:共用執行個體(VPC)

  • VPC_DEDICATED:專享執行個體(VPC)

VPC_SHARED

樣本

正常返回樣本

JSON格式

{
  "TagStatus": true,
  "BasePath": "/qqq",
  "RequestId": "FF3B7D81-66AE-47E0-BF69-157DCF187514",
  "Description": "The weather informations",
  "GroupName": "Weather",
  "GroupId": "523e8dc7bbe04613b5b1d726c2a7xx",
  "InstanceId": "apigateway-cn-v6419k43xxxxx",
  "SubDomain": "523e8dc7bbe04613b5b1d726xxxxxxxx-cn-hangzhou.alicloudapi.com",
  "InstanceType": "VPC_SHARED"
}

錯誤碼

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

變更歷史

更多資訊,參考變更詳情