DATASOURCE::ApiGateway::Groups类型用于查询当前存在的API分组列表及基本信息。

语法

{
  "Type": "DATASOURCE::ApiGateway::Groups",
  "Properties": {
    "GroupName": String,
    "InstanceId": String,
    "Sort": String,
    "GroupId": String
  }
}

属性

属性名称 类型 必须 允许更新 描述 约束
GroupName String 否 是 API分组名称。 无
InstanceId String 否 是 实例ID。 无
Sort String 否 是 排序。 取值：
  • asc：按修改时间升序排列。
  • desc：按修改时间降序排列。
GroupId String 否 是 API分组ID。 无

返回数据（Fn::GetAtt）

  • ApiGroups：API分组详情列表。
  • ApiGroupIds：API分组ID列表。
属性名称 类型 描述 约束
ApiGroupIds List API分组ID列表。 无
ApiGroups List API分组详情列表。 无
BillingStatus String 计费状态。 取值：
  • NORMAL：正常。
  • LOCKED：欠费锁定。
GroupId String API分组ID。 无
CreatedTime String 创建时间。 格林威治时间。格式为GMT-hh:mm。
Description String 分组描述。 无
GroupName String API分组名称。 无
HttpsPolicy String HTTPS安全策略。 无
IllegalStatus String 违法锁定。 取值：
  • NORMAL：正常。
  • LOCKED：违法锁定。
InstanceId String 实例ID。 无
InstanceType String 实例类型。 无
ModifiedTime String 最后修改时间。 格林威治时间。格式为GMT-hh:mm。
RegionId String 分组所在区域。 无
SubDomain String API分组对应的二级域名。 自定义域名CNAME所用。
TrafficLimit Integer 分组最高QPS限制。 默认值：500。
说明 您可以申请提高QPS限制值。
Tags Map 标签列表。 无

示例

  • JSON格式 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "GroupId": {
      "Type": "String",
      "Description": "API group ID."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Groups",
      "Properties": {
        "GroupId": {
          "Ref": "GroupId"
        }
      }
    }
  },
  "Outputs": {
    "ApiGroups": {
      "Description": "The information about ApiGateway groups.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroups"
        ]
      }
    },
    "ApiGroupIds": {
      "Description": "The list of The ApiGateway group ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroupIds"
        ]
      }
    }
  }
}

  • YAML格式 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  GroupId:
    Type: String
    Description: API group ID.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Groups
    Properties:
      GroupId:
        Ref: GroupId
Outputs:
  ApiGroups:
    Description: The information about ApiGateway groups.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroups
  ApiGroupIds:
    Description: The list of The ApiGateway group ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroupIds