すべてのプロダクト
Search

このプロダクト

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    ドキュメントセンター

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    最終更新日:Jan 16, 2025

    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: 仮想プライベートクラウド (VPC)

    • api-shared-classic-001: クラシックネットワーク

    InternetEnable

    Boolean

    いいえ

    はい

    パブリックサブドメインを有効にするかどうかを指定します。

    有効な値:

    • true

    • false

    PassthroughHeaders

    String

    いいえ

    いいえ

    パススルーヘッダー。

    値を host に設定します。

    Tags

    List

    いいえ

    はい

    API グループのタグ。

    API グループには最大 20 個のタグを追加できます。

    詳細については、「タグのプロパティ」をご参照ください。

    VpcIntranetEnable

    Boolean

    いいえ

    はい

    プライベートサブドメインを有効にするかどうかを指定します。

    有効な値:

    • true

    • false

    タグの構文

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

    タグのプロパティ

    プロパティ

    タイプ

    必須

    編集可能

    説明

    制約

    Key

    String

    はい

    いいえ

    タグキー。

    タグキーは 1 ～ 128 文字で、http:// または https:// を含めることはできません。タグキーは aliyun または acs: で始めることはできません。

    Value

    String

    いいえ

    いいえ

    タグ値。

    タグ値は最大 128 文字で、http:// または https:// を含めることはできません。タグ値は aliyun または acs: で始めることはできません。

    戻り値

    Fn::GetAtt

    • SubDomain: システムが API グループに割り当てるセカンドレベルドメイン。このドメインは、API 呼び出しのテストに使用されます。

    • GroupId: API グループの ID。ID はシステムによって生成される GUID です。

    • Tags: API グループのタグ。

    例

    説明

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