DATASOURCE::ApiGateway::Groups is used to query the details of existing API groups.

Syntax

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

Properties

Property Type Required Editable Description Constraint
GroupName String No Yes The name of the API group. None.
InstanceId String No Yes The ID of the instance None.
Sort String No Yes The order in which the API groups are displayed. Valid values:
  • asc: The API groups are displayed in ascending order of modification time.
  • desc: The API groups are displayed in descending order of modification time.
GroupId String No Yes The ID of the API group. None.

Return values (Fn::GetAtt)

  • ApiGroups: details of the API groups.
  • ApiGroupIds: the IDs of the API groups.
Property Type Description Constraint
ApiGroupIds List The IDs of the API groups. None.
ApiGroups List Details of the API groups. None.
BillingStatus String The billing status of the API group. Valid values:
  • NORMAL: The billing status of the API group is normal.
  • LOCKED: The API group is locked due to overdue payments.
GroupId String The ID of the API group. None.
CreatedTime String The time when the API group was created. The time is displayed in UTC. The time is in the yyyy-MM-ddThh:mm:ssZ format.
Description String The description of the API group. None.
GroupName String The name of the API group. None.
HttpsPolicy String The HTTPS security policy. None.
IllegalStatus String The validity status of the API group. Valid values:
  • NORMAL: The API group works as expected.
  • LOCKED: The API group is locked because it is not valid.
InstanceId String The ID of the instance None.
InstanceType String The type of the instance. None.
ModifiedTime String The time when the API group was last modified. The time is displayed in UTC. The time is in the yyyy-MM-ddThh:mm:ssZ format.
RegionId String The ID of the region in which the API group is deployed. None.
SubDomain String The second-level domain name that corresponds to the API group. The second-level domain name is used by the CNAME of the custom domain name
TrafficLimit Integer The upper QPS limit of the API group. Default value: 500.
Note You can make a request to increase the upper limit.
Tags Map The tags of the API group. None.

Examples

  • JSON format 

    {
  "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 format 

    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