All Products
Search
Document Center

API Gateway:DescribeApiGroup

Last Updated:Nov 26, 2024

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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.
OperationAccess levelResource typeCondition keyAssociated operation
apigateway:DescribeApiGroupget
*ApiGroup
acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdstringYes

The ID of the API group. This ID is generated by the system and globally unique.

523e8dc7bbe04613b5b1d726c2a7889d
Tagarray<object>No

The object tags that match the lifecycle rule. You can specify multiple tags.

Key, Value
objectNo

The tag.

KeystringNo

The key of the tag.

appname
ValuestringNo

The value of the tag.

test_app

Response parameters

ParameterTypeDescriptionExample
object
Statusstring

The status of the API group.

  • NORMAL: The API group is normal.
  • DELETE: The API group is deleted.
NORMAL
CompatibleFlagsstring

The list of associated tags. Separate multiple tags with commas (,).

depart:dep1
BasePathstring

The root path of the API.

/qqq
Ipv6Statusstring

The IPv6 status.

UNBIND
UserLogConfigstring

The user log settings.

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

The list of custom configuration items.

removeResponseServerHeader
RequestIdstring

The ID of the request.

03442A3D-3B7D-434C-8A95-A5FEB989B519
Descriptionstring

The description of the API group.

New weather informations.
HttpsPolicystring

The HTTPS policy.

HTTPS2_TLS1_0
SubDomainstring

The second-level domain name automatically assigned to the API group.

27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTimestring

The creation time (UTC) of the API group.

2016-08-01T06:53:02Z
DefaultDomainstring

The default domain name.

mkt.api.gaore.com
CmsMonitorGroupstring

The CloudMonitor application group.

217008423
BillingStatusstring

The billing status of the API group.

  • NORMAL: The API group is normal.
  • LOCKED: The API group is locked due to overdue payments.
NORMAL
TrafficLimitinteger

The upper QPS limit of the API group. The default value is 500. You can increase the upper limit by submitting an application.

500
PassthroughHeadersstring

Specifies whether to pass headers.

eagleeye-rpcid,x-b3-traceid
InstanceIdstring

The ID of the instance.

apigateway-cn-v6419k43xxxxx
VpcDomainstring

The VPC domain name.

e4****7151954***acbd9f7****1058a-ap-southeast-1-vpc.alicloudapi.com
InstanceTypestring

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
CustomTraceConfigstring

The custom trace configuration.

{\"parameterLocation\":\"HEADER\",\"parameterName\":\"traceId\"}
RegionIdstring

The region to which the API group belongs.

cn-hangzhou
ModifiedTimestring

The last modification time (UTC) of the API group.

2016-08-01T06:54:32Z
GroupIdstring

The ID of the API group. This ID is generated by the system and globally unique.

523e8dc7bbe04613b5b1d726c2a7889d
GroupNamestring

The name of the group to which the API belongs.

NewWeather
IllegalStatusstring

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
VpcSlbIntranetDomainstring

The VPC SLB domain name.

257e9d450e924d00b976b0ecfb7184c2-cn-beijing-intranet.alicloudapi.com
CustomDomainsarray<object>

The details about the custom domain name.

DomainItemobject

The custom domain name information.

BindStageNamestring

The environment in which the associated API group runs.

TEST
DomainLegalStatusstring

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 needs to be rectified as soon as possible.
ABNORMAL
CertificateNamestring

The name of the SSL certificate.

myCertificate
CustomDomainTypestring

The type of the custom domain name.

intranet
DomainCNAMEStatusstring

The domain name resolution status. Valid values:

  • RESOLVED
  • UNRESOLVED
RESOLVED
WildcardDomainPatternsstring

The wildcard domain name mode.

[\"{test}.test.com\"]
DomainBindingStatusstring

The binding status of the custom domain name. Valid values:

  • BINDING: The domain name is bound.
  • BOUND: The domain name is not bound.
BINDING
DomainNamestring

The domain name.

api.demo.com
DomainRemarkstring

Remarks about the domain name, such as the cause of an exception.

Indicates that the domain name does not have an ICP filing.
DomainWebSocketStatusstring

The status of the domain that uses the WebSocket feature.

CLOSE
CertificateIdstring

The SSL certificate ID, which is automatically generated by the system.

6EF60BEC-0242-43AF-BB20-270359FB54A7
IsHttpRedirectToHttpsboolean

Indicates whether to redirect HTTP requests to HTTPS.

false
CertificateValidStartlong

The time when the certificate takes effect.

1689043476000
CertificateValidEndlong

The time when the certificate expires.

2635123476000
BindStageAliasstring

The alias of the associated environment.

TEST1
StageItemsarray<object>

The runtime environment information.

StageInfoobject

The runtime environment information.

StageIdstring

The environment ID.

123e8dc7bbe01613b5b1d726c2a7888e
StageNamestring

The environment name.

TEST
Descriptionstring

The environment description.

MYTEST
CloudMarketCommodityboolean

The products on Alibaba Cloud Marketplace.

false
DedicatedInstanceTypestring

The type of exclusive instance where the group is located

  • VPC fusion type exclusive instance: vpc_connect
  • Traditional type exclusive instance: normal
normal
MigrationStatusstring

Group migration instance task status

  • Running
  • Success
  • Failed
Fail
MigrationErrorstring

The reason for the failure of the group migration instance task. When the value of the MigrationStatus parameter is Failed, it is not empty.

The current instance conflicts with the target instance.
DisableInnerDomainboolean

Indicates whether access over the public second-level domain name is enabled. Valid values:

  • true
  • false
false
CustomAppCodeConfigstring

The custom appcode configuration.

{"location":"HEADER","name":"myAppCodeHeader"}

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,
        "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\"}"
}

Error codes

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

Change history

Change timeSummary of changesOperation
2024-11-22The response structure of the API has changedView Change Details
2024-03-21The response structure of the API has changedView Change Details
2023-08-10The response structure of the API has changedView Change Details
2023-07-11The response structure of the API has changedView Change Details
2023-07-11The response structure of the API has changedView Change Details
2023-07-11The response structure of the API has changedView Change Details
2023-06-19The response structure of the API has changedView Change Details
2023-04-13API Description Update. The response structure of the API has changedView Change Details
2023-03-07The response structure of the API has changedView Change Details
2022-09-22The response structure of the API has changedView Change Details