全部产品
Search
文档中心

Resource Orchestration Service:ALIYUN::ApiGateway::Plugin

更新时间:Jun 26, 2025

ALIYUN::ApiGateway::Plugin digunakan untuk membuat plug-in Gateway API.

Sintaks

{
  "Type": "ALIYUN::ApiGateway::Plugin",
  "Properties": {
    "PluginName": String,
    "Description": String,
    "PluginData": String,
    "PluginType": String,
    "Tags": List
  }
}

Properti

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Batasan

PluginData

String

Ya

Ya

Pernyataan definisi dari plug-in.

Anda dapat menentukan pernyataan definisi dalam format JSON atau YAML.

PluginName

String

Ya

Ya

Nama dari plug-in.

Nama harus memiliki panjang 4 hingga 50 karakter dan dapat berisi huruf, angka, dan tanda hubung (-). Nama tidak boleh dimulai dengan tanda hubung (-).

PluginType

String

Ya

Tidak

Tipe dari plug-in.

Nilai yang valid:

  • ipControl: kontrol akses berbasis alamat IP

  • trafficControl: pembatasan laju

  • backendSignature: tanda tangan backend

  • jwtAuth: Token Web JSON (JWT) (OpenID Connect)

  • cors: Berbagi sumber daya lintas domain (CORS)

  • caching: caching

Description

String

Tidak

Ya

Deskripsi dari plug-in.

Deskripsi dapat memiliki panjang hingga 200 karakter.

Tags

List

Tidak

Ya

Tag dari plug-in.

Anda dapat menambahkan hingga 20 tag ke plug-in.

Untuk informasi lebih lanjut, lihat Properti Tags.

Sintaks Tags

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

Properti Tags

Properti

Tipe

Diperlukan

Dapat Diedit

Deskripsi

Batasan

Key

String

Ya

Tidak

Kunci tag.

Kunci tag harus memiliki panjang 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

  • Description: Deskripsi dari plug-in.

  • PluginName: Nama dari plug-in.

  • PluginData: Pernyataan definisi dari plug-in.

  • PluginId: ID dari plug-in.

  • PluginType: Tipe dari plug-in.

Contoh

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Description:
    Description: Deskripsi dari plug-in, yang tidak boleh melebihi 200 karakter.
    Type: String
  PluginData:
    Description: Pernyataan definisi dari plug-in. Pernyataan definisi plug-in dalam format JSON dan YAML didukung.
    Type: String
  PluginName:
    Description: Nama dari plug-in yang ingin Anda buat. Dapat berisi huruf besar bahasa Inggris, huruf kecil bahasa Inggris, karakter Cina, angka, dan garis bawah (). Harus memiliki panjang 4 hingga 50 karakter dan tidak boleh dimulai dengan garis bawah ().
    Type: String
  PluginType:
    Description: 'Tipe dari plug-in. Nilai valid: ipControl: menunjukkan kontrol akses berbasis alamat IP. trafficControl: menunjukkan pembatasan laju. backendSignature: menunjukkan tanda tangan backend. jwtAuth: menunjukkan JWT (OpenId Connect). cors: menunjukkan akses sumber daya lintas domain (CORS). caching: menunjukkan caching.'
    Type: String
Resources:
  ApiGatewayPlugin:
    Properties:
      Description:
        Ref: Description
      PluginData:
        Ref: PluginData
      PluginName:
        Ref: PluginName
      PluginType:
        Ref: PluginType
    Type: ALIYUN::ApiGateway::Plugin
Outputs:
  Description:
    Description: Deskripsi dari plug-in, yang tidak boleh melebihi 200 karakter.
    Value:
      Fn::GetAtt:
      - ApiGatewayPlugin
      - Description
  PluginData:
    Description: Pernyataan definisi dari plug-in. Pernyataan definisi plug-in dalam format JSON dan YAML didukung.
    Value:
      Fn::GetAtt:
      - ApiGatewayPlugin
      - PluginData
  PluginId:
    Description: ID plug-in yang dihasilkan.
    Value:
      Fn::GetAtt:
      - ApiGatewayPlugin
      - PluginId
  PluginName:
    Description: Nama dari plug-in yang ingin Anda buat. Dapat berisi huruf besar bahasa Inggris, huruf kecil bahasa Inggris, karakter Cina, angka, dan garis bawah (). Harus memiliki panjang 4 hingga 50 karakter dan tidak boleh dimulai dengan garis bawah ().
    Value:
      Fn::GetAtt:
      - ApiGatewayPlugin
      - PluginName
  PluginType:
    Description: 'Tipe dari plug-in. Nilai valid: ipControl: menunjukkan kontrol akses berbasis alamat IP. trafficControl: menunjukkan pembatasan laju. backendSignature: menunjukkan tanda tangan backend. jwtAuth: menunjukkan JWT (OpenId Connect). cors: menunjukkan akses sumber daya lintas domain (CORS). caching: menunjukkan caching.'
    Value:
      Fn::GetAtt:
      - ApiGatewayPlugin
      - PluginType

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PluginName": {
      "Type": "String",
      "Description": "Nama dari plug-in yang ingin Anda buat. Dapat berisi huruf besar bahasa Inggris, huruf kecil bahasa Inggris, karakter Cina, angka, dan garis bawah (). Harus memiliki panjang 4 hingga 50 karakter dan tidak boleh dimulai dengan garis bawah ()."
    },
    "Description": {
      "Type": "String",
      "Description": "Deskripsi dari plug-in, yang tidak boleh melebihi 200 karakter."
    },
    "PluginData": {
      "Type": "String",
      "Description": "Pernyataan definisi dari plug-in. Pernyataan definisi plug-in dalam format JSON dan YAML didukung."
    },
    "PluginType": {
      "Type": "String",
      "Description": "Tipe dari plug-in. Nilai valid: ipControl: menunjukkan kontrol akses berbasis alamat IP. trafficControl: menunjukkan pembatasan laju. backendSignature: menunjukkan tanda tangan backend. jwtAuth: menunjukkan JWT (OpenId Connect). cors: menunjukkan akses sumber daya lintas domain (CORS). caching: menunjukkan caching."
    }
  },
  "Resources": {
    "ApiGatewayPlugin": {
      "Type": "ALIYUN::ApiGateway::Plugin",
      "Properties": {
        "PluginName": {
          "Ref": "PluginName"
        },
        "Description": {
          "Ref": "Description"
        },
        "PluginData": {
          "Ref": "PluginData"
        },
        "PluginType": {
          "Ref": "PluginType"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "Deskripsi dari plug-in, yang tidak boleh melebihi 200 karakter.",
      "Value": {
        "Fn::GetAtt": [
          "ApiGatewayPlugin",
          "Description"
        ]
      }
    },
    "PluginName": {
      "Description": "Nama dari plug-in yang ingin Anda buat. Dapat berisi huruf besar bahasa Inggris, huruf kecil bahasa Inggris, karakter Cina, angka, dan garis bawah (). Harus memiliki panjang 4 hingga 50 karakter dan tidak boleh dimulai dengan garis bawah ().",
      "Value": {
        "Fn::GetAtt": [
          "ApiGatewayPlugin",
          "PluginName"
        ]
      }
    },
    "PluginData": {
      "Description": "Pernyataan definisi dari plug-in. Pernyataan definisi plug-in dalam format JSON dan YAML didukung.",
      "Value": {
        "Fn::GetAtt": [
          "ApiGatewayPlugin",
          "PluginData"
        ]
      }
    },
    "PluginId": {
      "Description": "ID plug-in yang dihasilkan.",
      "Value": {
        "Fn::GetAtt": [
          "ApiGatewayPlugin",
          "PluginId"
        ]
      }
    },
    "PluginType": {
      "Description": "Tipe dari plug-in. Nilai valid: ipControl: menunjukkan kontrol akses berbasis alamat IP. trafficControl: menunjukkan pembatasan laju. backendSignature: menunjukkan tanda tangan backend. jwtAuth: menunjukkan JWT (OpenId Connect). cors: menunjukkan akses sumber daya lintas domain (CORS). caching: menunjukkan caching.",
      "Value": {
        "Fn::GetAtt": [
          "ApiGatewayPlugin",
          "PluginType"
        ]
      }
    }
  }
}