調用DATASOURCE::ApiGateway::Groups查詢當前存在的API分組列表及基本資料 - Resource Orchestration Service

DATASOURCE::ApiGateway::Groups類型用於查詢當前存在的API分組列表及基本資料。

文法

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

屬性

屬性名稱	類型	必須	允許更新	描述	約束
GroupName	String	否	是	API分組名稱。	無
InstanceId	String	否	是	執行個體ID。	無
Sort	String	否	是	排序。	取值： asc：按修改時間升序排列。 desc：按修改時間降序排列。
GroupId	String	否	是	API分組ID。	無
RefreshOptions	String	否	是	當資源棧更新時，資料來源資源的重新整理策略。	取值： Never（預設值）：更新堆棧時，從不重新整理資料來源資源。 Always：更新堆棧時，始終重新整理資料來源資源。

返回資料（Fn::GetAtt）

ApiGroups：API分組詳情列表。
ApiGroupIds：API分組ID列表。

屬性名稱	類型	描述	約束
ApiGroupIds	List	API分組ID列表。	無
ApiGroups	List	API分組詳情列表。	無
BillingStatus	String	計費狀態。	取值： NORMAL：正常。 LOCKED：欠費鎖定。
GroupId	String	API分組ID。	無
CreatedTime	String	建立時間。	格林威治時間，格式為：yy-mm-dd-hh-mm。
Description	String	分組描述。	無
GroupName	String	API分組名稱。	無
HttpsPolicy	String	HTTPS安全性原則。	無
IllegalStatus	String	違法鎖定。	取值： NORMAL：正常。 LOCKED：違法鎖定。
InstanceId	String	執行個體ID。	無
InstanceType	String	執行個體類型。	無
ModifiedTime	String	最後修改時間。	格林威治時間，格式為：yy-mm-dd-hh-mm。
RegionId	String	分組所在地區。	無
SubDomain	String	API分組對應的次層網域。	自訂網域名CNAME所用。
TrafficLimit	Integer	分組最高QPS限制。	預設值：500。說明您可以申請提高QPS限制值。
Tags	Map	標籤列表。	無

樣本

`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

`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"
        ]
      }
    }
  }
}

文法

屬性

返回資料（Fn::GetAtt）

樣本

YAML格式

JSON格式

`YAML`格式

`JSON`格式