創建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 |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 |
返回參數
示例
正常返回示例
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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|
暫無變更歷史