DATASOURCE::ApiGateway::Groups - query existing API groups and their basic information - Resource Orchestration Service

Syntax

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

Properties

Property	Type	Required	Update allowed	Description	Constraints
GroupName	String	No	Yes	The name of the API group.	None
InstanceId	String	No	Yes	The instance ID.	None
Sort	String	No	Yes	The sort order.	Valid values: asc: Sorts results in ascending order by modification time. desc: Sorts results in descending order by modification time.
GroupId	String	No	Yes	The ID of the API group.	None
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): The data source resource is not refreshed when the stack is updated. Always: The data source resource is always refreshed when the stack is updated.

Return data (Fn::GetAtt)

ApiGroups: A list of API groups.
ApiGroupIds: A list of API group IDs.

Property name	Type	Description	Constraints
ApiGroupIds	List	A list of API group IDs.	None
ApiGroups	List	A list of API group details.	None
BillingStatus	String	The billing status.	Valid values: Normal LOCKED: The instance is locked due to an overdue payment.
GroupId	String	The ID of the API group.	None
CreatedTime	String	The creation time.	The time is in GMT. The format is yy-mm-dd-hh-mm.
Description	String	The description of the group.	None
GroupName	String	The name of the API group.	None
HttpsPolicy	String	The HTTPS security policy.	None
IllegalStatus	String	The lock status due to illegal activities.	Valid values: NORMAL: The instance is normal. LOCKED: The instance is locked due to illegal activities.
InstanceId	String	The instance ID.	None
InstanceType	String	The instance type.	None
ModifiedTime	String	The last modification time.	The time is in GMT. The format is yy-mm-dd-hh-mm.
RegionId	String	The region of the API group.	None
SubDomain	String	The second-level domain assigned to the API group.	Used as the CNAME for a custom domain name.
TrafficLimit	Integer	The maximum QPS limit of the group.	Default value: 500. Note You can request to increase the QPS limit.
Tags	Map	The tags of the API group.	None

Examples

`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 ApiGateway group IDs.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroupIds

`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 ApiGateway group IDs.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroupIds"
        ]
      }
    }
  }
}

Syntax

Properties

Return data (Fn::GetAtt)

Examples

YAML format

JSON format

`YAML` format

`JSON` format