AI 助理
备案控制台
文档
输入文档关键字查找
首页 API 网关 原API网关 开发参考 API参考指南 API目录 分组 DescribeApiGroup - 查询 API 分组详情

DescribeApiGroup - 查询 API 分组详情

更新时间：
产品详情
我的收藏

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

接口说明

  • 此功能面向 API 提供者

调试

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

授权信息

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

请求参数

名称类型必填描述示例值
GroupIdstring是

API 分组 ID，系统生成，全局唯一

523e8dc7bbe04613b5b1d726c2a7889d
Tagarray<object>否

指定规则所适用的对象标签，可设置多个。

Key， Value
object否

标签

Keystring否

标签键

appname
Valuestring否

标签值

test_app

返回参数

名称类型描述示例值
object
Statusstring

分组状态

  • NORMAL：正常
  • DELETE：删除
NORMAL
CompatibleFlagsstring

关联的标签列表，多个用逗号（,）分隔

depart:dep1
BasePathstring

api 根路径

/qqq
Ipv6Statusstring

ipv6 状态

UNBIND
UserLogConfigstring

用户日志设置

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

自定义配置项列表

removeResponseServerHeader
RequestIdstring

请求 ID

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

API 分组描述

New weather informations.
HttpsPolicystring

https 策略

HTTPS2_TLS1_0
SubDomainstring

系统为分组分配的二级域名

27d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com
CreatedTimestring

创建时间，格林威治时间

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

默认域名

mkt.api.gaore.com
CmsMonitorGroupstring

云监控应用分组

217008423
BillingStatusstring

计费状态

  • NORMAL：正常
  • LOCKED：欠费锁定
NORMAL
TrafficLimitinteger

分组最高 QPS 限制，默认 500，可申请提高

500
PassthroughHeadersstring

透传 Headers

eagleeye-rpcid,x-b3-traceid
InstanceIdstring

实例 ID

apigateway-cn-v6419k43xxxxx
VpcDomainstring

vpc 域名

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

实例类型

  • CLASSIC_SHARED：共享实例经典网络
  • VPC_SHARED：共享实例(VPC)
  • VPC_DEDICATED：专享实例(VPC)
VPC_SHARED
CustomTraceConfigstring

自定义 trace 配置

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

分组所在区域

cn-hangzhou
ModifiedTimestring

最后修改时间，格林威治时间

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

API 分组 ID，系统生成，全局唯一

523e8dc7bbe04613b5b1d726c2a7889d
GroupNamestring

API 分组名称

NewWeather
IllegalStatusstring

违法锁定

  • NORMAL：正常
  • LOCKED：违法锁定
NORMAL
VpcSlbIntranetDomainstring

内网 VPC SLB 域名

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

自定义域名信息

DomainItemobject

自定义域名信息

BindStageNamestring

绑定的运行环境名称

TEST
DomainLegalStatusstring

域名合法状态，取值：

  • NORMAL：正常
  • ABNORMAL：异常，该状态会影响 API 调用，需尽快解决
ABNORMAL
CertificateNamestring

SSL 证书名称

myCertificate
CustomDomainTypestring

自定义域名类型

intranet
DomainCNAMEStatusstring

域名解析情况，取值：

  • RESOLVED：已解析
  • UNRESOLVED：未解析
RESOLVED
WildcardDomainPatternsstring

通配域名模式

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

自定义域名绑定状态，取值：

  • BINDING：正常
  • BOUND：未生效
BINDING
DomainNamestring

域名名称

api.demo.com
DomainRemarkstring

域名相关备注，如描述域名异常状态原因

该域名未备案
DomainWebSocketStatusstring

使用 WebSocket 功能的域名状态

CLOSE
CertificateIdstring

SSL 证书 ID，系统自动生成唯一编号

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

是否将 http 重定向到 https

false
CertificateValidStartlong

证书生效时间

1689043476000
CertificateValidEndlong

证书失效时间

2635123476000
BindStageAliasstring

绑定的运行环境别名

TEST1
StageItemsarray<object>

运行环境信息

StageInfoobject

运行环境信息

StageIdstring

运行环境编号

123e8dc7bbe01613b5b1d726c2a7888e
StageNamestring

运行环境名称

TEST
Descriptionstring

运行环境描述

MYTEST
CloudMarketCommodityboolean

云市场商品

false
DedicatedInstanceTypestring

分组所在专享实例的类型

  • VPC 融合类型专享实例：vpc_connect
  • 传统类型专享实例：normal
normal
MigrationStatusstring

分组迁移实例任务状态

  • 运行中：Running
  • 成功：Success
  • 失败：Fail
Fail
MigrationErrorstring

分组迁移实例任务失败时，失败的原因。 当 MigrationStatus 参数值为 Fail 时，不为空。

The current instance conflicts with the target instance.
DisableInnerDomainboolean

是否禁止公网二级域名的访问

  • true：禁止公网二级域名访问
  • false：允许公网二级域名访问
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",
  "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
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-21OpenAPI 返回结构发生变更查看变更详情
2023-08-10OpenAPI 返回结构发生变更查看变更详情
2023-07-11OpenAPI 返回结构发生变更查看变更详情
2023-07-11OpenAPI 返回结构发生变更查看变更详情
2023-07-11OpenAPI 返回结构发生变更查看变更详情
2023-06-19OpenAPI 返回结构发生变更查看变更详情
2023-04-13OpenAPI 描述信息更新、OpenAPI 返回结构发生变更查看变更详情
2023-03-07OpenAPI 返回结构发生变更查看变更详情
2022-09-22OpenAPI 返回结构发生变更查看变更详情
上一篇：DescribeApiGroups - 查询 API 分组列表下一篇：DescribePurchasedApiGroup - 获取购买的 API 组
文档推荐