调用DescribeApiGroup查询API分组详情_API 网关(API Gateway)-阿里云帮助中心

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

接口说明

此功能面向 API 提供者

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
GroupId	string	是	API 分组 ID，系统生成，全局唯一	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	否	指定规则所适用的对象标签，可设置多个。	Key， Value
	object	否	标签
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
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
IllegalStatus	string	违法锁定 NORMAL：正常 LOCKED：违法锁定	NORMAL
VpcSlbIntranetDomain	string	内网 VPC SLB 域名	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	array<object>	自定义域名信息
DomainItem	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
CertificateValidStart	long	证书生效时间	1689043476000
CertificateValidEnd	long	证书失效时间	2635123476000
BindStageAlias	string	绑定的运行环境别名	TEST1
StageItems	array<object>	运行环境信息
StageInfo	object	运行环境信息
StageId	string	运行环境编号	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	运行环境名称	TEST
Description	string	运行环境描述	MYTEST
CloudMarketCommodity	boolean	云市场商品	false
DedicatedInstanceType	string	分组所在专享实例的类型 VPC 融合类型专享实例：vpc_connect 传统类型专享实例：normal	normal
MigrationStatus	string	分组迁移实例任务状态运行中：Running 成功：Success 失败：Fail	Fail
MigrationError	string	分组迁移实例任务失败时，失败的原因。当 MigrationStatus 参数值为 Fail 时，不为空。	The current instance conflicts with the target instance.
DisableInnerDomain	boolean	是否禁止公网二级域名的访问 true：禁止公网二级域名访问 false：允许公网二级域名访问	false
CustomAppCodeConfig	string	自定义 AppCode 配置	{"location":"HEADER","name":"myAppCodeHeader"}

示例

正常返回示例

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",
  "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",
  "IllegalStatus": "NORMAL",
  "VpcSlbIntranetDomain": "257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com",
  "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,
        "CertificateValidStart": 1689043476000,
        "CertificateValidEnd": 2635123476000,
        "BindStageAlias": "TEST1"
      }
    ]
  },
  "StageItems": {
    "StageInfo": [
      {
        "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
        "StageName": "TEST",
        "Description": "MYTEST"
      }
    ]
  },
  "CloudMarketCommodity": false,
  "DedicatedInstanceType": "normal",
  "MigrationStatus": "Fail",
  "MigrationError": "The current instance conflicts with the target instance.",
  "DisableInnerDomain": false,
  "CustomAppCodeConfig": "{\"location\":\"HEADER\",\"name\":\"myAppCodeHeader\"}"
}

错误码

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

变更历史

变更时间	变更内容概要	操作
2024-11-22	OpenAPI 返回结构发生变更	查看变更详情
2024-03-21	OpenAPI 返回结构发生变更	查看变更详情
2023-08-10	OpenAPI 返回结构发生变更	查看变更详情
2023-07-11	OpenAPI 返回结构发生变更	查看变更详情
2023-07-11	OpenAPI 返回结构发生变更	查看变更详情
2023-07-11	OpenAPI 返回结构发生变更	查看变更详情
2023-06-19	OpenAPI 返回结构发生变更	查看变更详情
2023-04-13	OpenAPI 描述信息更新、OpenAPI 返回结构发生变更	查看变更详情
2023-03-07	OpenAPI 返回结构发生变更	查看变更详情
2022-09-22	OpenAPI 返回结构发生变更	查看变更详情