Todos os produtos
Search
Central de documentação

Resource Orchestration Service:ALIYUN::VPC::IpamScope

Última atualização: Jun 27, 2026

O recurso ALIYUN::VPC::IpamScope cria um escopo de Gerenciamento de Endereços IP (IPAM).

Sintaxe

{
  "Type": "ALIYUN::VPC::IpamScope",
  "Properties": {
    "IpamId": String,
    "IpamScopeName": String,
    "IpamScopeDescription": String,
    "IpamScopeType": String,
    "Tags": List
  }
}

Propriedades

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

IpamId

String

Sim

Não

ID do IPAM.

Nenhuma.

IpamScopeName

String

Não

Sim

Nome do escopo IPAM.

De 1 a 128 caracteres. Não pode começar com http:// ou https://.

IpamScopeDescription

String

Não

Sim

Descrição do escopo IPAM.

De 1 a 256 caracteres. Deve começar com uma letra. Não pode iniciar com http:// ou https://. Vazio por padrão.

IpamScopeType

String

Não

Não

Tipo do escopo IPAM.

Defina o valor como private.

Nota

Somente é possível criar escopos IPAM privados.

Tags

List

Não

Sim

As tags.

Adicione até 20 tags. Para mais informações, consulte Propriedades de Tags.

Sintaxe de Tags

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

Propriedades de Tags

Propriedade

Tipo

Obrigatória

Editável

Descrição

Restrição

Key

String

Sim

Não

Chave da tag do escopo IPAM.

Não pode estar vazia.

Até 64 caracteres. Deve começar com uma letra. Pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). Não pode começar com aliyun ou acs:. Não pode conter http:// ou https://.

Value

String

Não

Não

Valor da tag do escopo IPAM.

Até 20 valores de tag. Pode ser uma string vazia.

Até 128 caracteres. Não pode conter http:// ou https://.

Valores de retorno

Fn::GetAtt

  • IpamScopeId: ID do escopo IPAM.

  • IpamScopeName: nome do escopo IPAM.

  • IpamId: ID do IPAM.

  • CreateTime: hora de criação do escopo IPAM.

  • IpamScopeDescription: descrição do escopo IPAM.

  • IpamScopeType: tipo do escopo IPAM.

  • Tags: tags adicionadas ao escopo IPAM.

Exemplos

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  IpamScopeName:
    Type: String
    Description:
      en: The name of the IPAM scope.
    Required: false
    Default: test_scope
  IpamId:
    Type: String
    Description:
      en: The id of the Ipam instance.
    Required: true
  IpamScopeType:
    Type: String
    Description:
      en: |-
        IPAM scope of action type:
        **private**.

        > Currently, only the role scope of the private network is supported.
    Required: false
    Default: private
Resources:
  ExtensionResource:
    Type: ALIYUN::VPC::IpamScope
    Properties:
      IpamScopeName:
        Ref: IpamScopeName
      IpamId:
        Ref: IpamId
      IpamScopeType:
        Ref: IpamScopeType
Outputs:
  IpamScopeId:
    Description: The ID of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeId
  IpamScopeName:
    Description: The name of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeName
  IpamId:
    Description: The id of the Ipam instance.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamId
  CreateTime:
    Description: The creation time of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreateTime
  IpamScopeDescription:
    Description: The description of the IPAM's scope of action.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeDescription
  IpamScopeType:
    Description: IPAM scope of action type.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - IpamScopeType
  Tags:
    Description: The tag of the IPAM scope.
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Tags
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "IpamScopeName": {
      "Type": "String",
      "Description": {
        "en": "The name of the IPAM scope."
      },
      "Required": false,
      "Default": "test_scope"
    },
    "IpamId": {
      "Type": "String",
      "Description": {
        "en": "The id of the Ipam instance."
      },
      "Required": true
    },
    "IpamScopeType": {
      "Type": "String",
      "Description": {
        "en": "IPAM scope of action type:\n**private**.\n\n> Currently, only the role scope of the private network is supported."
      },
      "Required": false,
      "Default": "private"
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::VPC::IpamScope",
      "Properties": {
        "IpamScopeName": {
          "Ref": "IpamScopeName"
        },
        "IpamId": {
          "Ref": "IpamId"
        },
        "IpamScopeType": {
          "Ref": "IpamScopeType"
        }
      }
    }
  },
  "Outputs": {
    "IpamScopeId": {
      "Description": "The ID of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeId"
        ]
      }
    },
    "IpamScopeName": {
      "Description": "The name of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeName"
        ]
      }
    },
    "IpamId": {
      "Description": "The id of the Ipam instance.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamId"
        ]
      }
    },
    "CreateTime": {
      "Description": "The creation time of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreateTime"
        ]
      }
    },
    "IpamScopeDescription": {
      "Description": "The description of the IPAM's scope of action.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeDescription"
        ]
      }
    },
    "IpamScopeType": {
      "Description": "IPAM scope of action type.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "IpamScopeType"
        ]
      }
    },
    "Tags": {
      "Description": "The tag of the IPAM scope.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Tags"
        ]
      }
    }
  }
}