DescribeApiGroup - 查询 API 分组详情 - API 网关

查询API分组的详情信息，包含分组系统自动生成的二级域名、自定义域名及SSL证书信息。

接口说明

此功能面向API提供者

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
apigateway:DescribeApiGroup	Read	ApiGateway acs:apigateway::{#accountId}:	无	无

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	API分组ID，系统生成，全局唯一	523e8dc7bbe04613b5b1d726c2a7889d
Tag	object []	否	指定规则所适用的对象标签，可设置多个。	Key， Value
Key	string	否	标签键	appname
Value	string	否	标签值	test_app

返回参数

名称	类型	描述	示例值
	object
Status	string	分组状态 NORMAL：正常 DELETE：删除	NORMAL
CompatibleFlags	string	关联的标签列表，多个用逗号（,）分隔	depart:dep1
BasePath	string	api根路径	/qqq
Ipv6Status	string	ipv6状态	UNBIND
UserLogConfig	string	用户日志设置	{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigs	string	自定义配置项列表	removeResponseServerHeader
RequestId	string	请求ID	03442A3D-3B7D-434C-8A95-A5FEB989B519
Description	string	API分组描述	New weather informations.
HttpsPolicy	string	https策略	HTTPS2_TLS1_0
SubDomain	string	系统为分组分配的二级域名	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	创建时间，格林威治时间	2016-08-01T06:53:02Z
RpcPattern	string	RPC 模式
DefaultDomain	string	默认域名	mkt.api.gaore.com
CmsMonitorGroup	string	云监控应用分组	217008423
BillingStatus	string	计费状态 NORMAL：正常 LOCKED：欠费锁定	NORMAL
TrafficLimit	integer	分组最高QPS限制，默认500，可申请提高	500
PassthroughHeaders	string	透传 Headers	eagleeye-rpcid,x-b3-traceid
InstanceId	string	实例ID	apigateway-cn-v6419k43xxxxx
VpcDomain	string	vpc域名	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	实例类型 CLASSIC_SHARED：共享实例经典网络 VPC_SHARED：共享实例(VPC) VPC_DEDICATED：专享实例(VPC)	VPC_SHARED
CustomTraceConfig	string	自定义trace配置	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	分组所在区域	cn-hangzhou
ModifiedTime	string	最后修改时间，格林威治时间	2016-08-01T06:54:32Z
GroupId	string	API分组 ID，系统生成，全局唯一	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	API分组名称	NewWeather
ClassicVpcSubDomain	string	VPC二级域名
IllegalStatus	string	违法锁定 NORMAL：正常 LOCKED：违法锁定	NORMAL
InstanceVipList	string	实例vip列表
VpcSlbIntranetDomain	string	内网VPC SLB域名
CustomDomains	object []	自定义域名信息
BindStageName	string	绑定的运行环境名称	TEST
DomainLegalStatus	string	域名合法状态，取值： NORMAL：正常 ABNORMAL：异常，该状态会影响API调用，需尽快解决	ABNORMAL
CertificateName	string	SSL证书名称	myCertificate
CustomDomainType	string	自定义域名类型	intranet
DomainCNAMEStatus	string	域名解析情况，取值： RESOLVED：已解析 UNRESOLVED：未解析	RESOLVED
WildcardDomainPatterns	string	通配域名模式	[\"{test}.test.com\"]
DomainBindingStatus	string	自定义域名绑定状态，取值： BINDING：正常 BOUND：未生效	BINDING
DomainName	string	域名名称	api.demo.com
DomainRemark	string	域名相关备注，如描述域名异常状态原因	该域名未备案
DomainWebSocketStatus	string	使用WebSocket功能的域名状态	CLOSE
CertificateId	string	SSL证书ID，系统自动生成唯一编号	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	是否将http重定向到https	false
StageItems	object []	运行环境信息
StageId	string	运行环境编号	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	运行环境名称	TEST
Description	string	运行环境描述	MYTEST
CloudMarketCommodity	boolean	云市场商品	false

示例

正常返回示例

JSON格式

{
  "Status": "NORMAL",
  "CompatibleFlags": "depart:dep1",
  "BasePath": "/qqq",
  "Ipv6Status": "UNBIND",
  "UserLogConfig": "{\\\"requestBody\\\":true,\\\"responseBody\\\":true,\\\"queryString\\\":\\\"test\\\",\\\"requestHeaders\\\":\\\"test\\\",\\\"responseHeaders\\\":\\\"test\\\",\\\"jwtClaims\\\":\\\"test\\\"}",
  "CustomerConfigs": "removeResponseServerHeader",
  "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
  "Description": "New weather informations.",
  "HttpsPolicy": "HTTPS2_TLS1_0",
  "SubDomain": "27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
  "CreatedTime": "2016-08-01T06:53:02Z",
  "RpcPattern": "",
  "DefaultDomain": "mkt.api.gaore.com",
  "CmsMonitorGroup": "217008423",
  "BillingStatus": "NORMAL",
  "TrafficLimit": 500,
  "PassthroughHeaders": "eagleeye-rpcid,x-b3-traceid",
  "InstanceId": "apigateway-cn-v6419k43xxxxx",
  "VpcDomain": "e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com",
  "InstanceType": "VPC_SHARED",
  "CustomTraceConfig": "{\\\"parameterLocation\\\":\\\"HEADER\\\",\\\"parameterName\\\":\\\"traceId\\\"}",
  "RegionId": "cn-hangzhou",
  "ModifiedTime": "2016-08-01T06:54:32Z",
  "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
  "GroupName": "NewWeather",
  "ClassicVpcSubDomain": "",
  "IllegalStatus": "NORMAL",
  "InstanceVipList": "",
  "VpcSlbIntranetDomain": "",
  "CustomDomains": {
    "DomainItem": [
      {
        "BindStageName": "TEST",
        "DomainLegalStatus": "ABNORMAL",
        "CertificateName": "myCertificate",
        "CustomDomainType": "intranet",
        "DomainCNAMEStatus": "RESOLVED",
        "WildcardDomainPatterns": "[\\\"{test}.test.com\\\"]",
        "DomainBindingStatus": "BINDING",
        "DomainName": "api.demo.com",
        "DomainRemark": "该域名未备案",
        "DomainWebSocketStatus": "CLOSE",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "IsHttpRedirectToHttps": false,
        "WssEnable": "",
        "CertificateValidStart": 0,
        "CertificateValidEnd": 0
      }
    ]
  },
  "StageItems": {
    "StageInfo": [
      {
        "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
        "StageName": "TEST",
        "Description": "MYTEST"
      }
    ]
  },
  "CloudMarketCommodity": false,
  "DedicatedInstanceType": ""
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2023-04-13

OpenAPI 描述信息更新，OpenAPI 返回结构发生变更

变更项	变更内容
API 描述	OpenAPI 描述信息更新
出参	OpenAPI 返回结构发生变更

2023-03-07

OpenAPI 返回结构发生变更

变更项	变更内容
出参	OpenAPI 返回结构发生变更

2022-09-22

OpenAPI 返回结构发生变更

变更项	变更内容
出参	OpenAPI 返回结构发生变更