全部產品
Search

搜尋本產品

    Resource Orchestration Service：ALIYUN::ApiGateway::Group

    文件中心

    Resource Orchestration Service：ALIYUN::ApiGateway::Group

    更新時間：Jun 19, 2024

    ALIYUN::ApiGateway::Group類型用於建立API分組。

    文法

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

    屬性

    屬性名稱

    類型

    必須

    允許更新

    描述

    約束

    GroupName

    String

    是

    是

    API分組名稱。

    名稱必須唯一。

    長度為4~50個字元。必須以英文字母或漢字開頭。可包含英文字母、漢字、數字和底線（_）。

    BasePath

    String

    否

    是

    API根路徑。

    樣本：/qqq。

    Description

    String

    否

    是

    API分組描述。

    長度不超過180個字元。

    InstanceId

    String

    否

    否

    API Gateway執行個體類型。

    取值：

    • api-shared-vpc-001：專用網路。

    • api-shared-classic-001：傳統網路。

    InternetEnable

    Boolean

    否

    是

    是否啟用公網子網域名稱。

    取值：

    • true：啟用公網子網域名稱。

    • false：不啟用公網子網域名稱。

    PassthroughHeaders

    String

    否

    否

    配置透傳。

    取值：host。

    Tags

    List

    否

    是

    標籤。

    最多可以設定20個標籤。

    更多資訊，請參見Tags屬性。

    VpcIntranetEnable

    Boolean

    否

    是

    是否啟用私網子網域名稱。

    取值：

    • true：啟用私網子網域名稱。

    • false：不啟用私網子網域名稱。

    Tags文法

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

    Tags屬性

    屬性名稱

    類型

    必須

    允許更新

    描述

    約束

    Key

    String

    是

    否

    標籤鍵。

    長度為1~128個字元，不能以aliyun和acs:開頭，不能包含http://或https:// 。

    Value

    String

    否

    否

    標籤值。

    長度為0~128個字元，不能以aliyun和acs:開頭，不能包含http://或https:// 。

    傳回值

    Fn::GetAtt

    • SubDomain：系統給API分組綁定的次層網域，用於測試API調用情況。

    • GroupId：API分組ID。通過系統產生，全域唯一。

    • Tags：標籤。

    樣本

    說明

    請您根據實際情況更改脫敏的參數取值，例如InstanceId。

    YAML格式 

    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格式 

    {
  "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": {
  }
}