DescribeApiGroup - API Gateway - Alibaba Cloud Documentation Center

You can call this operation to query details about an API group, including the automatically assigned second-level domain name, custom domain name, and SSL certificate.

Operation description

This operation is intended for API providers.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:DescribeApiGroup	Read	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
GroupId	string	Yes	The ID of the API group. This ID is generated by the system and globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
Tag	object []	No	The object tags that match the lifecycle rule. You can specify multiple tags.	Key， Value
Key	string	No	The key of the tag.	appname
Value	string	No	The value of the tag.	test_app

Response parameters

Parameter	Type	Description	Example
	object
Status	string	The status of the API group. NORMAL: The API group is normal. DELETE: The API group is deleted.	NORMAL
CompatibleFlags	string	The list of associated tags. Separate multiple tags with commas (,).	depart:dep1
BasePath	string	The root path of the API.	/qqq
Ipv6Status	string	The IPv6 status.	UNBIND
UserLogConfig	string	The user log settings.	{\"requestBody\":true,\"responseBody\":true,\"queryString\":\"test\",\"requestHeaders\":\"test\",\"responseHeaders\":\"test\",\"jwtClaims\":\"test\"}
CustomerConfigs	string	The list of custom configuration items.	removeResponseServerHeader
RequestId	string	The ID of the request.	03442A3D-3B7D-434C-8A95-A5FEB989B519
Description	string	The description of the API group.	New weather informations.
HttpsPolicy	string	The HTTPS policy.	HTTPS2_TLS1_0
SubDomain	string	The second-level domain name automatically assigned to the API group.	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	The creation time (UTC) of the API group.	2016-08-01T06:53:02Z
DefaultDomain	string	The default domain name.	mkt.api.gaore.com
CmsMonitorGroup	string	The CloudMonitor application group.	217008423
BillingStatus	string	The billing status of the API group. NORMAL: The API group is normal. LOCKED: The API group is locked due to overdue payments.	NORMAL
TrafficLimit	integer	The upper QPS limit of the API group. The default value is 500. You can increase the upper limit by submitting an application.	500
PassthroughHeaders	string	Specifies whether to pass headers.	eagleeye-rpcid,x-b3-traceid
InstanceId	string	The ID of the instance.	apigateway-cn-v6419k43xxxxx
VpcDomain	string	The VPC domain name.	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	The type of the instance. CLASSIC_SHARED: shared instance that uses the classic network configuration VPC_SHARED: shared instance that uses VPC VPC_DEDICATED: dedicated instance that uses VPC	VPC_SHARED
CustomTraceConfig	string	The custom trace configuration.	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	The region to which the API group belongs.	cn-hangzhou
ModifiedTime	string	The last modification time (UTC) of the API group.	2016-08-01T06:54:32Z
GroupId	string	The ID of the API group. This ID is generated by the system and globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	The name of the group to which the API belongs.	NewWeather
IllegalStatus	string	The validity status of the API group. Valid values: NORMAL: The API group is normal. LOCKED: The API group is locked because it is not valid.	NORMAL
VpcSlbIntranetDomain	string	The VPC SLB domain name.	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object []	The custom domain name information.
BindStageName	string	The environment in which the associated API group runs.	TEST
DomainLegalStatus	string	The validity status of the domain name. Valid values: NORMAL: The domain name is valid. ABNORMAL: The domain name is invalid. This status affects API calls and must be resolved as soon as possible.	ABNORMAL
CertificateName	string	The SSL certificate name.	myCertificate
CustomDomainType	string	The type of the custom domain name.	intranet
DomainCNAMEStatus	string	The domain name resolution status. Valid values: RESOLVED UNRESOLVED	RESOLVED
WildcardDomainPatterns	string	The wildcard domain name mode.	[\"{test}.test.com\"]
DomainBindingStatus	string	The binding status of the custom domain name. Valid values: BINDING: The domain name is bound. BOUND: The domain name is not bound.	BINDING
DomainName	string	The domain name.	api.demo.com
DomainRemark	string	Remarks about the domain name, such as the cause of an exception.	Indicates that the domain name does not have an ICP filing.
DomainWebSocketStatus	string	The status of the domain name that uses the WebSocket feature.	CLOSE
CertificateId	string	The unique ID of the SSL certificate, which is automatically generated by the system.	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	Indicates whether to redirect HTTP requests as HTTPS requests.	false
CertificateValidStart	long	The time when the certificate takes effect.	1689043476000
CertificateValidEnd	long	The time when the certificate expires.	2635123476000
StageItems	object []	The runtime environment information.
StageId	string	The environment ID.	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	The environment name.	TEST
Description	string	The environment description.	MYTEST
CloudMarketCommodity	boolean	The products on Alibaba Cloud Marketplace.	false
DisableInnerDomain	boolean	Indicates whether access over the public second-level domain name is enabled. Valid values: true false	false

Examples

Sample success responses

JSONformat

{
  "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": "Indicates that the domain name does not have an ICP filing.\n",
        "DomainWebSocketStatus": "CLOSE",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "IsHttpRedirectToHttps": false,
        "CertificateValidStart": 1689043476000,
        "CertificateValidEnd": 2635123476000
      }
    ]
  },
  "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
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time

Summary of changes

Operation

2024-03-21

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-08-10

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-07-11

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-07-11

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-07-11

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-06-19

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2023-04-13

API Description Update. The response structure of the API has changed

see changesets

Change item	Change content
API Description	API Description Update.
Output Parameters	The response structure of the API has changed.

2023-03-07

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.

2022-09-22

The response structure of the API has changed

see changesets

Change item	Change content
Output Parameters	The response structure of the API has changed.