All Products
Search

This Product

    Resource Orchestration Service:DATASOURCE::ApiGateway::Groups

    Document Center

    Resource Orchestration Service:DATASOURCE::ApiGateway::Groups

    Last Updated:Oct 29, 2024

    DATASOURCE::ApiGateway::Groups is used to query the information about existing API groups.

    Syntax

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

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    GroupName

    String

    No

    Yes

    The name of the API group.

    None.

    InstanceId

    String

    No

    Yes

    The instance ID.

    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.

    RefreshOptions

    String

    No

    Yes

    The refresh policy for data source resources when the stack is updated.

    Valid values:

    • Never (default): does not refresh data source resources when the stack is updated.

    • Always: refreshes data source resources when the stack is updated.

    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 state 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 follows the ISO 8601 standard in the yy-mm-dd-hh-mm 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 is valid.

    • LOCKED: The API group is locked because it is invalid.

    InstanceId

    String

    The instance ID.

    None.

    InstanceType

    String

    The instance type.

    None.

    ModifiedTime

    String

    The time when the API group was last modified.

    The time is displayed in UTC. The time follows the ISO 8601 standard in the yy-mm-dd-hh-mm format.

    RegionId

    String

    The region of the API group.

    None.

    SubDomain

    String

    The second-level domain name that corresponds to the API group.

    The second-level domain name is used by the canonical name (CNAME) of the custom domain name.

    TrafficLimit

    Integer

    The maximum queries per second (QPS) of the API group.

    Default value: 500.

    Note

    You can make a request to increase the maximum QPS.

    Tags

    Map

    The tags.

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