首页 API 网关 开发指南 API参考指南 API目录 分组 DescribeApiGroup - 查询 API 分组详情

DescribeApiGroup - 查询 API 分组详情

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

接口说明

  • 此功能面向API提供者

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:DescribeApiGroupRead
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

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

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

523e8dc7bbe04613b5b1d726c2a7889d
Tagarray

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

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
RpcPatternstring

RPC 模式

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
ClassicVpcSubDomainstring

VPC二级域名

IllegalStatusstring

违法锁定

  • NORMAL:正常
  • LOCKED:违法锁定
NORMAL
InstanceVipListstring

实例vip列表

VpcSlbIntranetDomainstring

内网VPC SLB域名

CustomDomainsarray

自定义域名信息

object

自定义域名信息

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
WssEnablestring
StageItemsarray

运行环境信息

object

运行环境信息

StageIdstring

运行环境编号

123e8dc7bbe01613b5b1d726c2a7888e
StageNamestring

运行环境名称

TEST
Descriptionstring

运行环境描述

MYTEST
CloudMarketCommodityboolean

云市场商品

false

示例

正常返回示例

JSON格式

{
    "RequestId": "03442A3D-3B7D-434C-8A95-A5FEB989B519",
    "GroupId": "523e8dc7bbe04613b5b1d726c2a7889d",
    "GroupName": "NewWeather",
    "SubDomain": "927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com",
    "Description": "New weather informations.",
    "CreatedTime": "2016-08-01T06:53:02Z",
    "ModifiedTime": "2016-08-01T06:54:32Z",
    "RegionId": "cn-hangzhou",
    "Status": "NORMAL",
    "BillingStatus": "NORMAL",
    "IllegalStatus": "NORMAL",
    "TrafficLimit": "500",
    "CustomDomains": {
      "CustomDomain": {
        "DomainName": "api.demo.com",
        "CertificateId": "6EF60BEC-0242-43AF-BB20-270359FB54A7",
        "CertificateName": "myCertificate",
        "DomainNameResolution": "RESOLVED",
        "DomainStatus": "BINDING",
        "DomainLegalStatus":"ABNORMAL",
        "DomainRemark":"该域名未备案"
      }
    },
    "StageItems": {
      "StageInfo": [
        {
          "StageId": "123e8dc7bbe01613b5b1d726c2a7887e",
          "StageName": "RELEASE",
          "Description": "MYRELEASE"
        },
        {
          "StageId": "123e8dc7bbe01613b5b1d726c2a7888e",
          "StageName": "TEST",
          "Description": "MYTEST"
        }
      ]
    }
}

XML格式

<DescribeApiGroupResponse>
    <RequestId>03442A3D-3B7D-434C-8A95-A5FEB989B519</RequestId>
    <GroupId>523e8dc7bbe04613b5b1d726c2a7889d</GroupId>
    <GroupName>NewWeather</GroupName>
    <SubDomain>927d50c0f2e54b359919923d908bb015-cn-hangzhou.alicloudapi.com</SubDomain>
    <Description>New weather informations.</Description>
    <CreatedTime>2016-08-01T06:53:02Z</CreatedTime>
    <ModifiedTime>2016-08-01T06:54:32Z</ModifiedTime>
    <RegionId>cn-hangzhou</RegionId>
    <Status>NORMAL</Status>
    <BillingStatus>NORMAL</BillingStatus>
    <IllegalStatus>NORMAL</IllegalStatus>
    <TrafficLimit>500</TrafficLimit>
    <CustomDomains>
        <CustomDomain>
            <DomainName>api.demo.com</DomainName>
            <CertificateId>6EF60BEC-0242-43AF-BB20-270359FB54A7</CertificateId>
            <CertificateName>myCertificate</CertificateName>
            <DomainNameResolution>RESOLVED</DomainNameResolution>
            <DomainStatus>BINDING</DomainStatus>
            <DomainLegalStatus>ABNORMAL</DomainLegalStatus>
            <DomainRemark>该域名未备案</DomainRemark>
        </CustomDomain>
    </CustomDomains>
    <StageItems>
        <StageInfo>
            <StageId>123e8dc7bbe01613b5b1d726c2a7887e</StageId>
            <StageName>RELEASE</StageName>
            <Description>MYRELEASE</Description>
        </StageInfo>
        <StageInfo>
            <StageId>123e8dc7bbe01613b5b1d726c2a7888e</StageId>
            <StageName>TEST</StageName>
            <Description>MYTEST</Description>
        </StageInfo>
    </StageItems>
</DescribeApiGroupResponse>

错误码

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

变更历史

变更时间变更内容概要操作
2022-09-22OpenAPI 返回结构发生变更
变更项变更内容
出参OpenAPI 返回结构发生变更
阿里云首页 API 网关 相关技术圈