查询当前存在的API分组列表及基本信息。
接口说明
- 此功能面向 API 提供者
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:DescribeApiGroups | get |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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"
}
]
}
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史