Gunakan DATASOURCE::ApiGateway::Apis dalam pemanggilan untuk menanyakan daftar API di API Gateway. - Resource Orchestration Service

DATASOURCE::ApiGateway::Apis digunakan untuk menanyakan API di API Gateway.

Sintaksis

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

Properti

Properti	Tipe	Diperlukan	Dapat Diedit	Deskripsi	Batasan
EnableTagAuth	Boolean	Tidak	Ya	Menentukan apakah akan mengaktifkan verifikasi tag.	Nilai yang valid: true false
ApiName	String	Tidak	Ya	Nama API.	Pencocokan kabur didukung.
Visibility	String	Tidak	Ya	Visibilitas dari API.	Nilai yang valid: PUBLIC: Jika Anda menetapkan properti ini ke PUBLIC, API ditampilkan di halaman API di konsol API Gateway untuk semua pengguna setelah API diterbitkan ke lingkungan produksi. PRIVATE: Jika Anda menetapkan properti ini ke PRIVATE, API tidak diterbitkan di Alibaba Cloud Marketplace setelah grup API dari API tersedia di Alibaba Cloud Marketplace.
ApiId	String	Tidak	Ya	ID API.	Tidak ada.
CatalogId	String	Tidak	Ya	ID kategori.	Tidak ada.
GroupId	String	Tidak	Ya	ID grup API tempat API tersebut berada.	Tidak ada.
RefreshOptions	String	Tidak	Ya	Kebijakan refresh untuk sumber daya sumber data ketika tumpukan diperbarui.	Nilai yang valid: Never (default): tidak merefresh sumber daya sumber data ketika tumpukan diperbarui. Always: merefresh sumber daya sumber data ketika tumpukan diperbarui.

Nilai pengembalian (Fn::GetAtt)

ApiIds: ID dari API.
Apis: detail dari API.

Properti	Tipe	Deskripsi	Batasan
ApiIds	Daftar	ID dari API.	Tidak ada.
Apis	Daftar	Detail dari API.	Tidak ada.
Visibility	String	Visibilitas dari API.	Nilai yang valid: PUBLIC PRIVATE
ApiId	String	ID API.	Tidak ada.
ModifiedTime	String	Waktu ketika API dimodifikasi.	Waktu ditampilkan dalam UTC.
Description	String	Deskripsi dari API.	Tidak ada.
GroupName	String	Nama grup API tempat API tersebut berada.	Tidak ada.
GroupId	String	ID grup API tempat API tersebut berada.	Tidak ada.
CreatedTime	String	Waktu pembuatan.	Waktu ditampilkan dalam UTC.
ApiName	String	Nama API.	Tidak ada.
RegionId	String	ID wilayah dari API.	Tidak ada.

Contoh

JSON Format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiId": {
      "Type": "String",
      "Description": "ID dari API yang ditentukan."
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::ApiGateway::Apis",
      "Properties": {
        "ApiId": {
          "Ref": "ApiId"
        }
      }
    }
  },
  "Outputs": {
    "Apis": {
      "Description": "Informasi tentang ApiGateway apis.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Apis"
        ]
      }
    },
    "ApiIds": {
      "Description": "Daftar ID ApiGateway api.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiIds"
        ]
      }
    }
  }
}

YAML Format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiId:
    Type: String
    Description: ID dari API yang ditentukan.
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::ApiGateway::Apis
    Properties:
      ApiId:
        Ref: ApiId
Outputs:
  Apis:
    Description: Informasi tentang ApiGateway apis.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Apis
  ApiIds:
    Description: Daftar ID ApiGateway api.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiIds