DescribeApiGroup_API 网关_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 此功能面向 API 提供者

流控信息

请求速率为100/1(s)。更多流控信息,请前往配额中心查看

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiGroup
Get
ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

请求参数

字段名称字段详情
GroupIdstring

API 分组 ID,系统生成,全局唯一

示例值:523e8dc7bbe04613b5b1d726c2a7889d参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
Tagarray<object>

指定规则所适用的对象标签,可设置多个。

示例值:Key, Value子级条数 <= 500

返回参数

字段名称字段详情
Statusstring

分组状态展开详情

示例值:NORMAL
CompatibleFlagsstring

关联的标签列表,多个用逗号(,)分隔

示例值:depart:dep1
BasePathstring

api 根路径

示例值:/qqq
Ipv6Statusstring

ipv6 状态

示例值:UNBIND
UserLogConfigstring

用户日志设置

示例值:{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigsstring

自定义配置项列表

示例值:removeResponseServerHeader
RequestIdstring

请求 ID

示例值:03442A3D-3B7D-434C-8A95-A5FEB989B519
Descriptionstring

API 分组描述

示例值:New weather informations.
HttpsPolicystring

https 策略

示例值:HTTPS2_TLS1_0
SubDomainstring

系统为分组分配的二级域名

示例值:27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTimestring

创建时间,格林威治时间

示例值:2016-08-01T06:53:02Z
DefaultDomainstring

默认域名

示例值:mkt.api.gaore.com
CmsMonitorGroupstring

云监控应用分组

示例值:217008423
BillingStatusstring

计费状态展开详情

示例值:NORMAL
TrafficLimitinteger<int32>

分组最高 QPS 限制,默认 500,可申请提高

示例值:500
PassthroughHeadersstring

透传 Headers

示例值:eagleeye-rpcid,x-b3-traceid
InstanceIdstring

实例 ID

示例值:apigateway-cn-v6419k43xxxxx
VpcDomainstring

vpc 域名

示例值:e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceTypestring

实例类型展开详情

示例值:VPC_SHARED
CustomTraceConfigstring

自定义 trace 配置

示例值:{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionIdstring

分组所在区域

示例值:cn-hangzhou
ModifiedTimestring

最后修改时间,格林威治时间

示例值:2016-08-01T06:54:32Z
GroupIdstring

API 分组 ID,系统生成,全局唯一

示例值:523e8dc7bbe04613b5b1d726c2a7889d
GroupNamestring

API 分组名称

示例值:NewWeather
IllegalStatusstring

违法锁定展开详情

示例值:NORMAL
VpcSlbIntranetDomainstring

内网 VPC SLB 域名

示例值:257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomainsobject
StageItemsobject
CloudMarketCommodityboolean

云市场商品

示例值:false
DedicatedInstanceTypestring

分组所在专享实例的类型展开详情

示例值:normal
MigrationStatusstring

分组迁移实例任务状态展开详情

示例值:Fail
MigrationErrorstring

分组迁移实例任务失败时,失败的原因。展开详情

示例值:The current instance conflicts with the target instance.
DisableInnerDomainboolean

是否禁止公网二级域名的访问展开详情

示例值:false
CustomAppCodeConfigstring

自定义 AppCode 配置

示例值:{"location":"HEADER","name":"myAppCodeHeader"}

返回示例

变更历史

变更时间变更内容概要操作
2024-11-22
变更返回参数
2024-03-21
变更返回参数
2023-08-10
变更返回参数
2023-07-11
变更返回参数
2023-07-11
变更返回参数
2023-07-11
变更返回参数
2023-06-19
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例