开发者社区 问答 正文

如何查询 API 分组详情?



描述


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

  • 此功能面向API提供者
  • 用于查询指定分组全部详情信息


请求参数


名称类型是否必须描述
ActionString接口名称,系统规定参数,取值:DescribeApiGroup
GroupIdStringAPI分组 ID,系统生成,全局唯一


返回参数


名称类型描述
RequestIdString请求唯一标识
GroupIDStringAPI分组 ID,系统生成,全局唯一
GroupNameStringAPI分组名称
SubDomainString系统为分组分配的二级域名
DescriptionStringAPI分组描述
CreatedTimeString创建时间,格林威治时间
ModifiedTimeString最后修改时间,格林威治时间
RegionIdString分组所在区域
StatusString分组状态
  • NORMAL:正常
  • DELETE:删除
BillingStatusString计费状态
  • NORMAL:正常
  • LOCKED:欠费锁定
IllegalStatusString违法锁定
  • NORMAL:正常
  • LOCKED:违法锁定
TrafficLimitInteger分组最高QPS限制,默认500,可申请提高
CustomDomainsCustomDomain自定义域名信息
StageItemsStageInfo运行环境信息


示例



请求示例






JSON [font=PingFangSC, 'helvetica neue', 'hiragino sans gb', arial, 'microsoft yahei ui', 'microsoft yahei', simsun, sans-serif]格式
[font=PingFangSC, 'helvetica neue', 'hiragino sans gb', arial, 'microsoft yahei ui', 'microsoft yahei', simsun, sans-serif]

展开
收起
轩墨 2017-10-26 13:44:00 1747 分享 版权
阿里云 AI 助理回答

功能描述: 此API用于查询指定API分组的详细信息,适用于API提供者想要获取其创建的API分组所有详情的情景。查询内容包括但不限于系统自动生成的二级域名、配置的自定义域名以及与这些域名关联的SSL证书信息,有助于API提供者管理和监控其API服务的状态。

请求参数

  • Action: String 类型,是接口名称,系统预设参数,固定取值为 DescribeApiGroup
  • GroupId: String 类型,必填参数,表示API分组ID,由系统生成,全局唯一。

返回参数

  • RequestId:String类型,请求的唯一标识。
  • GroupId:String类型,API分组ID,系统生成,全局唯一。
  • GroupName:String类型,API分组的名称。
  • SubDomain:String类型,系统为该分组分配的二级域名。
  • Description:String类型,对API分组的描述信息。
  • CreatedTime:String类型,分组的创建时间,采用格林威治时间表示。
  • ModifiedTime:String类型,分组最后修改的时间,采用格林威治时间表示。
  • RegionId:String类型,分组所在的区域。
  • Status:String类型,分组状态,正常为NORMAL,删除状态为DELETE
  • BillingStatus:String类型,计费状态,正常为NORMAL,欠费锁定为LOCKED
  • IllegalStatus:String类型,违法状态锁定情况,正常为NORMAL,违法锁定为LOCKED
  • TrafficLimit:Integer类型,分组允许的最大QPS限制,默认500,可申请提升。
  • CustomDomains:CustomDomain类型,包含自定义域名的详细信息。
  • StageItems:StageInfo类型,运行环境的具体信息。

示例

请求示例采用JSON格式,具体构造请参考实际调用时的文档指南和要求,确保ActionGroupId字段正确设置。

注意事项

  • 在调用此接口前,请确保已拥有查询API分组详情所需的权限。
  • 记得替换请求中的GroupId为实际需要查询的分组ID。
  • 关注返回的分组状态和计费状态,以及时了解服务是否正常及账务状况。

参考资料: DescribeApiGroup 接口文档, 自定义域名详情查询相关说明。

有帮助
无帮助
AI 助理回答生成答案可能存在不准确,仅供参考
0 条回答
写回答
取消 提交回答