All Products
Search

This Product

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Document Center

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Last Updated:Jul 10, 2024

    ALIYUN::ApiGateway::Group is used to create an API group.

    Syntax

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

    Properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    GroupName

    String

    Yes

    Yes

    The name of the API group.

    The name must be unique.

    The name must be 4 to 50 characters in length and can contain letters, digits, and underscores (_). The name must start with a letter.

    BasePath

    String

    No

    Yes

    The root path of the API.

    Example: /qqq.

    Description

    String

    No

    Yes

    The description of the API group.

    The description can be up to 180 characters in length.

    InstanceId

    String

    No

    No

    The network type of the API Gateway instance.

    Valid values:

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

    • api-shared-classic-001: classic network

    InternetEnable

    Boolean

    No

    Yes

    Specifies whether to enable public subdomains.

    Valid values:

    • true

    • false

    PassthroughHeaders

    String

    No

    No

    The pass-through header.

    Set the value to host.

    Tags

    List

    No

    Yes

    The tags of the API group.

    You can add up to 20 tags to the API group.

    For more information, see Tags properties.

    VpcIntranetEnable

    Boolean

    No

    Yes

    Specifies whether to enable private subdomains.

    Valid values:

    • true

    • false

    Tags syntax

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

    Tags properties

    Property

    Type

    Required

    Editable

    Description

    Constraint

    Key

    String

    Yes

    No

    The tag key.

    The tag key must be 1 to 128 characters in length and cannot contain http:// or https://. The tag key cannot start with aliyun or acs:.

    Value

    String

    No

    No

    The tag value.

    The tag value can be up to 128 characters in length and cannot contain http:// or https://. The tag value cannot start with aliyun or acs:.

    Return values

    Fn::GetAtt

    • SubDomain: the second-level domain that the system assigns to the API group. The domain is used to test API calls.

    • GroupId: the ID of the API group. The ID is a GUID generated by the system.

    • Tags: the tags of the API group.

    Examples

    Note

    Change the values of masked parameters, such as InstanceId, based on your business requirements.

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