調用DATASOURCE::ApiGateway::Apis查詢API Gateway的API列表 -

DATASOURCE::ApiGateway::Apis類型用於查詢API Gateway的API列表。

文法

{
  "Type": "DATASOURCE::ApiGateway::Apis",
  "Properties": {
    "EnableTagAuth": Boolean,
    "ApiName": String,
    "Visibility": String,
    "ApiId": String,
    "CatalogId": String,
    "GroupId": String,
    "RefreshOptions": String
  }
}

屬性

屬性名稱	類型	必須	允許更新	描述	約束
EnableTagAuth	Boolean	否	是	是否啟用標籤驗證。	取值： true：啟用標籤驗證。 false：禁用標籤驗證。
ApiName	String	否	是	API名稱。	模糊比對。
Visibility	String	否	是	API是否公開。	取值： PUBLIC：公開。如果選擇此類型，該API的線上環境定義，會在所有使用者的控制台“發現API”頁面可見。 PRIVATE：不公開。如果選擇此類型，當該組API在雲市場上架時，私人類型的API不會上架。
ApiId	String	否	是	指定的API編號。	無
CatalogId	String	否	是	分類ID。	無
GroupId	String	否	是	指定的分組編號。	無
RefreshOptions	String	否	是	當資源棧更新時，資料來源資源的重新整理策略。	有效值： Never（預設值）：更新堆棧時，從不重新整理資料來源資源。 Always：更新堆棧時，始終重新整理資料來源資源。

返回資料（Fn::GetAtt）

ApiIds：API編號清單。
Apis：API的詳情列表。

屬性名稱	類型	描述	約束
ApiIds	List	API編號清單。	無
Apis	List	API的詳情列表。	無
Visibility	String	可見度。	取值： PUBLIC：公開。 PRIVATE：私人。
ApiId	String	API編號。	無
ModifiedTime	String	修改時間。	格林威治時間。
Description	String	API描述。	無
GroupName	String	API分組名稱。	無
GroupId	String	API分組編號。	無
CreatedTime	String	建立時間。	格林威治時間。
ApiName	String	API名稱。	無
RegionId	String	API所在地區ID。	無

樣本

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiId": {
      "Type": "String",
      "Description": "ID of the specified API."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Apis",
      "Properties": {
        "ApiId": {
          "Ref": "ApiId"
        }
      }
    }
  },
  "Outputs": {
    "Apis": {
      "Description": "The information about ApiGateway apis.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Apis"
        ]
      }
    },
    "ApiIds": {
      "Description": "The list of The ApiGateway api ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiIds"
        ]
      }
    }
  }
}

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiId:
    Type: String
    Description: ID of the specified API.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Apis
    Properties:
      ApiId:
        Ref: ApiId
Outputs:
  Apis:
    Description: The information about ApiGateway apis.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Apis
  ApiIds:
    Description: The list of The ApiGateway api ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiIds