全部产品
Search
文档中心

资源编排:ALIYUN::ApiGateway::SignatureBinding

更新时间:Jun 14, 2024

ALIYUN::ApiGateway::SignatureBinding类型用于绑定API与后端签名。

语法

{
  "Type": "ALIYUN::ApiGateway::SignatureBinding",
  "Properties": {
    "ApiIds": List,
    "GroupId": String,
    "StageName": String,
    "SignatureId": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

ApiIds

List

要操作的API编号。

支持输入多个,最多支持100个。

GroupId

String

要操作的API所属分组ID。

SignatureId

String

要操作的签名密钥ID 。

StageName

String

要操作的API环境。

取值:

  • TEST

  • PRE

  • RELEASE

返回值

Fn::GetAtt

无。

示例

说明

请您根据实际情况更改脱敏的参数取值,例如SignatureName、SignatureKey、SignatureSecret。

YAML格式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  ApiIds:
    Type: String
    Description: API ID
  GroupId:
    Type: String
    Description: Group ID
Resources:
  Signature:
    Type: ALIYUN::ApiGateway::Signature
    Properties:
      SignatureName: ros_tes****
      SignatureKey: demo_test****
      SignatureSecret: demo_test_se****
  SignatureBinding:
    Type: ALIYUN::ApiGateway::SignatureBinding
    Properties:
      GroupId:
        Ref: GroupId
      SignatureId:
        Ref: Signature
      ApiIds:
        - Ref: ApiIds
      StageName: PRE

JSON格式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "ApiIds": {
      "Type": "String",
      "Description": "API ID"
    },
    "GroupId": {
      "Type": "String",
      "Description": "Group ID"
    }
  },
  "Resources": {
    "Signature": {
      "Type": "ALIYUN::ApiGateway::Signature",
      "Properties": {
        "SignatureName": "ros_tes****",
        "SignatureKey": "demo_test****",
        "SignatureSecret": "demo_test_se****"
      }
    },
    "SignatureBinding": {
      "Type": "ALIYUN::ApiGateway::SignatureBinding",
      "Properties": {
        "GroupId": {
         "Ref": "GroupId"
        },
        "SignatureId": {
          "Ref": "Signature"
        },
        "ApiIds": [{
          "Ref": "ApiIds"
        }],
        "StageName": "PRE"
      }
    }
  }
}