DATASOURCE::ApiGateway::Groups - kueri grup API yang ada dan informasi dasarnya - Resource Orchestration Service

DATASOURCE::ApiGateway::Groups melakukan kueri terhadap grup API yang ada dan mengembalikan informasi dasarnya.

Sintaksis

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

Properti

Properti	Type	Wajib	Pembaruan diizinkan	Deskripsi	Batasan
GroupName	String	Tidak	Ya	Nama grup API.	Tidak ada
InstanceId	String	Tidak	Ya	ID instans.	Tidak ada
Sort	String	Tidak	Ya	Urutan pengurutan.	Nilai yang valid: asc: Mengurutkan hasil dalam urutan menaik berdasarkan waktu modifikasi. desc: Mengurutkan hasil dalam urutan menurun berdasarkan waktu modifikasi.
GroupId	String	Tidak	Ya	ID grup API.	Tidak ada
RefreshOptions	String	Tidak	Ya	Kebijakan refresh untuk resource data source saat stack diperbarui.	Nilai yang valid: Never (default): Resource data source tidak direfresh saat stack diperbarui. Always: Resource data source selalu direfresh saat stack diperbarui.

Data yang dikembalikan (Fn::GetAtt)

ApiGroups: Daftar grup API.
ApiGroupIds: Daftar ID grup API.

Nama properti	Type	Deskripsi	Batasan
ApiGroupIds	List	Daftar ID grup API.	Tidak ada
ApiGroups	List	Daftar detail grup API.	Tidak ada
BillingStatus	String	Status penagihan.	Nilai yang valid: Normal LOCKED: Instans terkunci karena pembayaran tertunda.
GroupId	String	ID grup API.	Tidak ada
CreatedTime	String	Waktu pembuatan.	Waktu dalam GMT. Formatnya adalah yy-mm-dd-hh-mm.
Description	String	Deskripsi grup.	Tidak ada
GroupName	String	Nama grup API.	Tidak ada
HttpsPolicy	String	Kebijakan keamanan HTTPS.	Tidak ada
IllegalStatus	String	Status terkunci akibat aktivitas ilegal.	Nilai yang valid: NORMAL: Instans dalam kondisi normal. LOCKED: Instans terkunci karena aktivitas ilegal.
InstanceId	String	ID instans.	Tidak ada
InstanceType	String	Tipe instans.	Tidak ada
ModifiedTime	String	Waktu modifikasi terakhir.	Waktu dalam GMT. Formatnya adalah yy-mm-dd-hh-mm.
RegionId	String	Wilayah grup API.	Tidak ada
SubDomain	String	Domain tingkat kedua yang ditetapkan untuk grup API.	Digunakan sebagai CNAME untuk nama domain kustom.
TrafficLimit	Integer	Batas maksimum QPS grup.	Nilai default: 500. Catatan Anda dapat mengajukan permintaan untuk menaikkan batas QPS.
Tags	Map	Tag grup API.	Tidak ada

Contoh

`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: Informasi tentang grup ApiGateway.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ApiGroups
  ApiGroupIds:
    Description: Daftar ID grup ApiGateway.
    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": "Informasi tentang grup ApiGateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroups"
        ]
      }
    },
    "ApiGroupIds": {
      "Description": "Daftar ID grup ApiGateway.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ApiGroupIds"
        ]
      }
    }
  }
}

Sintaksis

Properti

Data yang dikembalikan (Fn::GetAtt)

Contoh

YAML format

JSON format

`YAML` format

`JSON` format