查詢當前存在的API分組列表及基本信息。
接口說明
- 此功能面向 API 提供者
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apigateway:DescribeApiGroups | get | *ApiGroup acs:apigateway:{#regionId}:{#accountId}:apigroup/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GroupId | string | 否 | API 分組 ID，系統生成，全局唯一 | be6d2abcc0dd4f749fc2d2edd6567164 |
| GroupName | string | 否 | API 組名稱中，可指定的關鍵字 | Traffic |
| PageNumber | integer | 否 | 指定要查詢的頁碼，默認是 1，起始是 1 | 1 |
| PageSize | integer | 否 | 指定分頁查詢時每頁行數，最大值 50，默認值為 10 | 10 |
| EnableTagAuth | boolean | 否 | 是否啟用標簽驗證 | true |
| InstanceId | string | 否 | 實例 ID | apigateway-cn-v6419k43245xx |
| Sort | string | 否 | 排序，默認值是 desc，可選 asc，desc
| desc |
| Tag | array<object> | 否 | 標簽列表 | |
| object | 否 | |||
| Key | string | 否 | 標簽的 key | key |
| Value | string | 否 | 標簽的 value | value |
返回參數
示例
正常返回示例
JSON格式
{
"PageNumber": 1,
"RequestId": "D6E46F10-F26C-4AA0-BB69-FE2743D9AE62",
"PageSize": 10,
"TotalCount": 2,
"ApiGroupAttributes": {
"ApiGroupAttribute": [
{
"BasePath": "/v2/",
"BillingStatus": "NORMAL",
"TrafficLimit": 500,
"InstanceId": "apigateway-cn-v6419k43245xx",
"InstanceType": "VPC_SHARED",
"RegionId": "cn-hangzhou",
"ModifiedTime": "2016-08-01T08:45:15Z",
"GroupId": "be6d2abcc0dd4f749fc2d2edd6567164",
"GroupName": "Traffic",
"Description": "TrafficInformations.",
"IllegalStatus": "NORMAL",
"HttpsPolicy": "HTTPS2_TLS1_0",
"SubDomain": "be6d2abcc0dd4f749fc2d2edd6567164-cn-hangzhou.alicloudapi.com",
"CreatedTime": "2016-08-01T08:45:15Z",
"Tags": {
"TagInfo": [
{
"Key": "key",
"Value": "value"
}
]
}
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-11-14 | OpenAPI 描述信息更新 | 查看變更詳情 |