全部产品
Search

搜索本产品

    Resource Orchestration Service：ALIYUN::ApiGateway::Group

    文档中心

    Resource Orchestration Service：ALIYUN::ApiGateway::Group

    更新时间：Jun 26, 2025

    ALIYUN::ApiGateway::Group digunakan untuk membuat grup API.

    Sintaksis

    {
  "Type": "ALIYUN::ApiGateway::Group",
  "Properties": {
    "GroupName": String,
    "Description": String,
    "InstanceId": String,
    "PassthroughHeaders": String,
    "InternetEnable": Boolean,
    "VpcIntranetEnable": Boolean,
    "Tags": List,
    "BasePath": String
  }
}

    Properti

    Properti

    Tipe

    Diperlukan

    Dapat Diedit

    Deskripsi

    Kendala

    GroupName

    String

    Ya

    Ya

    Nama grup API.

    Nama harus unik.

    Nama harus terdiri dari 4 hingga 50 karakter dan dapat berisi huruf, angka, serta garis bawah (_). Nama harus dimulai dengan huruf.

    BasePath

    String

    Tidak

    Ya

    Root path dari API.

    Contoh: /qqq.

    Description

    String

    Tidak

    Ya

    Deskripsi grup API.

    Deskripsi dapat memiliki panjang hingga 180 karakter.

    InstanceId

    String

    Tidak

    Tidak

    Tipe jaringan dari instance API Gateway.

    Nilai yang valid:

    • api-shared-vpc-001: virtual private cloud (VPC)

    • api-shared-classic-001: jaringan klasik

    InternetEnable

    Boolean

    Tidak

    Ya

    Menentukan apakah akan mengaktifkan subdomain publik.

    Nilai yang valid:

    • true

    • false

    PassthroughHeaders

    String

    Tidak

    Tidak

    Header pass-through.

    Atur nilainya menjadi host.

    Tags

    List

    Tidak

    Ya

    Tag grup API.

    Anda dapat menambahkan hingga 20 tag ke grup API.

    Untuk informasi lebih lanjut, lihat Properti Tags.

    VpcIntranetEnable

    Boolean

    Tidak

    Ya

    Menentukan apakah akan mengaktifkan subdomain pribadi.

    Nilai yang valid:

    • true

    • false

    Sintaksis Tags

    "Tags": [
  {
    "Value": String,
    "Key": String
  }
]

    Properti Tags

    Properti

    Tipe

    Diperlukan

    Dapat Diedit

    Deskripsi

    Kendala

    Key

    String

    Ya

    Tidak

    Kunci tag.

    Kunci tag harus terdiri dari 1 hingga 128 karakter dan tidak boleh mengandung http:// atau https://. Kunci tag tidak boleh dimulai dengan aliyun atau acs:.

    Value

    String

    Tidak

    Tidak

    Nilai tag.

    Nilai tag dapat memiliki panjang hingga 128 karakter dan tidak boleh mengandung http:// atau https://. Nilai tag tidak boleh dimulai dengan aliyun atau acs:.

    Nilai Pengembalian

    Fn::GetAtt

    • SubDomain: Domain tingkat kedua yang ditetapkan sistem ke grup API. Domain ini digunakan untuk menguji panggilan API.

    • GroupId: ID grup API. ID ini adalah GUID yang dihasilkan oleh sistem.

    • Tags: Tag grup API.

    Contoh

    Catatan

    Ubah nilai parameter yang disembunyikan, seperti InstanceId, sesuai dengan kebutuhan bisnis Anda.

    YAML format 

    ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  Group:
    Type: ALIYUN::ApiGateway::Group
    Properties:
      InternetEnable: false
      GroupName: TestGroup
      InstanceId: api-shared-vpc-***
      VpcIntranetEnable: false
      PassthroughHeaders: host
Outputs: {}

    JSON format 

    {
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "Group": {
      "Type": "ALIYUN::ApiGateway::Group",
      "Properties": {
        "InternetEnable": false,
        "GroupName": "TestGroup",
        "InstanceId": "api-shared-vpc-***",
        "VpcIntranetEnable": false,
        "PassthroughHeaders": "host"
      }
    }
  },
  "Outputs": {
  }
}