Tous les produits
Search

Ce produit

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Centre de documentation

    Resource Orchestration Service:ALIYUN::ApiGateway::Group

    Dernière mise à jour :Aug 10, 2026

    La ressource ALIYUN::ApiGateway::Group permet de créer un groupe d'API.

    Syntaxe

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

    Propriétés

    Property

    Type

    Required

    Editable

    Description

    Constraint

    GroupName

    String

    Yes

    Yes

    Nom du groupe d'API.

    Le nom doit être unique.

    Longueur : 4 à 50 caractères. Caractères autorisés : lettres, chiffres et traits de soulignement (_). Le nom doit commencer par une lettre.

    BasePath

    String

    No

    Yes

    Chemin racine de l'API.

    Exemple : /qqq.

    Description

    String

    No

    Yes

    Description du groupe d'API.

    Longueur maximale : 180 caractères.

    InstanceId

    String

    No

    No

    Type de réseau de l'instance API Gateway.

    Valeurs valides :

    • api-shared-vpc-001 : Virtual Private Cloud (VPC)

    • api-shared-classic-001 : réseau classique

    InternetEnable

    Boolean

    No

    Yes

    Indique si les sous-domaines publics sont activés.

    Valeurs valides :

    • true

    • false

    PassthroughHeaders

    String

    No

    No

    En-tête de transfert transparent (pass-through).

    Définissez la valeur sur host.

    Tags

    List

    No

    Yes

    Tags du groupe d'API.

    Ajoutez jusqu'à 20 tags au groupe d'API.

    Pour plus d'informations, consultez Propriétés des tags.

    VpcIntranetEnable

    Boolean

    No

    Yes

    Indique si les sous-domaines privés sont activés.

    Valeurs valides :

    • true

    • false

    Syntaxe des tags

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

    Propriétés des tags


    Property


    Type


    Required


    Editable


    Description


    Constraint


    Key


    String


    Yes


    No


    Clé du tag.


    Longueur : 1 à 128 caractères. La clé ne peut pas contenir http:// ni https://, et ne doit pas commencer par aliyun ou acs:.


    Value


    String


    No


    No


    Valeur du tag.


    Longueur maximale : 128 caractères. La valeur ne peut pas contenir http:// ni https://, et ne doit pas commencer par aliyun ou acs:.

    Valeurs de retour

    Fn::GetAtt

    • SubDomain : sous-domaine de second niveau attribué par le système au groupe d'API. Ce domaine sert à tester les appels d'API.

    • GroupId : ID du groupe d'API. Il s'agit d'un GUID généré par le système.

    • Tags : tags associés au groupe d'API.

    Exemples

    Remarque

    Adaptez les valeurs des paramètres masqués, tels que InstanceId, en fonction de vos besoins métier.

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

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