DescribeApiGroup - API Gateway - Alibaba Cloud Documentation Center

Queries the details of a specified API group, including its system-generated second-level domain name, custom domain names, and SSL Certificate information.

Operation description

This operation is intended for API providers.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:DescribeApiGroup

get

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

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 is globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
Tag	array<object>	No	The object tags. You can specify multiple tags.	Key， Value
	object	No	A tag.
Key	string	No	The tag key.	appname
Value	string	No	The tag value.	test_app

Response elements

Element	Type	Description	Example
	object
Status	string	The status of the group. NORMAL: The group is normal. DELETE: The group is deleted.	NORMAL
CompatibleFlags	string	A list of associated tags. Multiple tags are separated by 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 request ID.	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 that is assigned to the group by the system.	27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTime	string	The creation time, which is in UTC.	2016-08-01T06:53:02Z
DefaultDomain	string	The default domain name.	mkt.api.gaore.com
CmsMonitorGroup	string	The Cloud Monitor application group.	217008423
BillingStatus	string	The billing status. NORMAL: The billing is normal. LOCKED: The group is locked due to an overdue payment.	NORMAL
TrafficLimit	integer	The maximum number of queries per second (QPS) for the group. The default value is 500. To increase the limit, submit a request.	500
PassthroughHeaders	string	The pass-through headers.	eagleeye-rpcid,x-b3-traceid
InstanceId	string	The instance ID.	apigateway-cn-v6419k43xxxxx
VpcDomain	string	The VPC domain name.	e4**7151954acbd9f7***1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceType	string	The instance type. CLASSIC_SHARED: a shared instance in the classic network. VPC_SHARED: a shared instance in a VPC. VPC_DEDICATED: a dedicated instance in a VPC.	VPC_SHARED
CustomTraceConfig	string	The custom trace configuration.	{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionId	string	The region where the group is located.	cn-hangzhou
ModifiedTime	string	The last modification time, in UTC.	2016-08-01T06:54:32Z
GroupId	string	The ID of the API group. This ID is generated by the system and is globally unique.	523e8dc7bbe04613b5b1d726c2a7889d
GroupName	string	The name of the API group.	NewWeather
IllegalStatus	string	The lock status due to illegal activities. NORMAL: The group is normal. LOCKED: The group is locked due to illegal activities.	NORMAL
VpcSlbIntranetDomain	string	The private domain name of the VPC SLB instance.	257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomains	object
DomainItem	array<object>	The information about the custom domain name.
	object	The information about the custom domain name.
BindStageName	string	The name of the environment to which the domain name is bound.	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. Resolve the issue as soon as possible.	ABNORMAL
CertificateName	string	The name of the SSL certificate.	myCertificate
CustomDomainType	string	The type of the custom domain name.	intranet
DomainCNAMEStatus	string	The CNAME resolution status of the domain name. Valid values: RESOLVED: The domain name is resolved. UNRESOLVED: The domain name is not resolved.	RESOLVED
WildcardDomainPatterns	string	The wildcard domain name pattern.	[\"{test}.test.com\"]
DomainBindingStatus	string	The binding status of the custom domain name. Valid values: BINDING: The domain name is being bound. BOUND: The domain name is bound.	BINDING
DomainName	string	The domain name.	api.demo.com
DomainRemark	string	The remarks about the domain name, such as the cause of an exception.	该域名未备案
DomainWebSocketStatus	string	The status of the domain name that is used for WebSocket connections.	CLOSE
CertificateId	string	The ID of the SSL certificate. This ID is automatically generated by the system and is unique.	6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttps	boolean	Indicates whether HTTP requests are redirected to HTTPS.	false
CertificateValidStart	integer	The time when the certificate becomes valid.	1689043476000
CertificateValidEnd	integer	The time when the certificate expires.	2635123476000
BindStageAlias	string	The alias of the environment to which the domain name is bound.	TEST1
SslVerifyDepth	integer	The certificate verification depth.	2
SslOcspEnable	boolean	Indicates whether Online Certificate Status Protocol (OCSP) validation is supported.	true
SslOcspCacheEnable	boolean	Indicates whether OCSP caching is supported.	true
ClientCertSDnPassThrough	boolean	Indicates whether the `ssl_client_s_dn` value in the certificate is passed to the backend service through the `X-Client-S-Dn` header.	true
StageItems	object
StageInfo	array<object>	The information about the environment.
	object	The information about the environment.
StageId	string	The environment ID.	123e8dc7bbe01613b5b1d726c2a7888e
StageName	string	The environment name.	TEST
Description	string	The description of the environment.	MYTEST
CloudMarketCommodity	boolean	The Alibaba Cloud Marketplace product.	false
DedicatedInstanceType	string	The type of the dedicated instance in which the group is located. VPC-connected dedicated instance: `vpc_connect` Legacy dedicated instance: `normal`	normal
MigrationStatus	string	The status of the task to migrate the group to another instance. `Running` `Success` `Fail`	Fail
MigrationError	string	The cause of the migration failure. This parameter is returned when the value of `MigrationStatus` is `Fail`.	The current instance conflicts with the target instance.
DisableInnerDomain	boolean	Indicates whether to disable access from the internet through the second-level domain name. `true`: Access from the internet through the second-level domain name is disabled. `false`: Access from the internet through the second-level domain name is allowed.	false
CustomAppCodeConfig	string	The custom AppCode configuration.	{"location":"HEADER","name":"myAppCodeHeader"}

Examples

Success response

JSON format

{
  "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",
        "SslVerifyDepth": 2,
        "SslOcspEnable": true,
        "SslOcspCacheEnable": true,
        "ClientCertSDnPassThrough": true
      }
    ]
  },
  "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\"}"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.