DATASOURCE::ApiGateway::Apis データソースで API をクエリ - Resource Orchestration Service

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: このプロパティを PUBLIC に設定すると、API が本番環境に公開された後、すべてのユーザーに対して API Gateway コンソールの [API] ページに API が表示されます。 PRIVATE: このプロパティを PRIVATE に設定すると、API の API グループが Alibaba Cloud Marketplace で利用可能になった後、API は Alibaba Cloud Marketplace で公開されません。
ApiId	String	いいえ	はい	API ID。	なし。
CatalogId	String	いいえ	はい	カテゴリ ID。	なし。
GroupId	String	いいえ	はい	API が属する API グループの ID。	なし。
RefreshOptions	String	いいえ	はい	スタックが更新されたときのデータソースリソースの更新ポリシー。	有効な値: Never (デフォルト): スタックが更新されたときにデータソースリソースを更新しません。 Always: スタックが更新されたときにデータソースリソースを更新します。

戻り値 (Fn::GetAtt)

ApiIds: API の ID。
Apis: API の詳細。

プロパティ	タイプ	説明	制約
ApiIds	List	API の ID。	なし。
Apis	List	API の詳細。	なし。
Visibility	String	API の可視性。	有効な値: PUBLIC PRIVATE
ApiId	String	API ID。	なし。
ModifiedTime	String	API が変更された時刻。	時刻は UTC で表示されます。
Description	String	API の説明。	なし。
GroupName	String	API が属する API グループの名前。	なし。
GroupId	String	API が属する API グループの ID。	なし。
CreatedTime	String	作成時刻。	時刻は UTC で表示されます。
ApiName	String	API 名。	なし。
RegionId	String	API のリージョン ID。	なし。

例

JSON 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiId": {
      "Type": "String",
      // 指定された API の ID。
      "Description": "ID of the specified API."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Apis",
      "Properties": {
        "ApiId": {
          "Ref": "ApiId"
        }
      }
    }
  },
  "Outputs": {
    "Apis": {
      // ApiGateway API に関する情報。
      "Description": "The information about ApiGateway apis.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Apis"
        ]
      }
    },
    "ApiIds": {
      // ApiGateway API ID のリスト。
      "Description": "The list of The ApiGateway api ids.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiIds"
        ]
      }
    }
  }
}

YAML 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiId:
    Type: String
    # 指定された API の ID。
    Description: ID of the specified API.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Apis
    Properties:
      ApiId:
        Ref: ApiId
Outputs:
  Apis:
    # ApiGateway API に関する情報。
    Description: The information about ApiGateway apis.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Apis
  ApiIds:
    # ApiGateway API ID のリスト。
    Description: The list of The ApiGateway api ids.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiIds