CreateIpamScope - Virtual Private Cloud: Central de Documentação do Alibaba Cloud

Cria escopos de IPAM privados e públicos para gerenciar endereços IP privados e públicos, respectivamente.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

vpc:CreateIpamScope

create

*Todos os recursos.

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região hospedada para o IPAM. Você pode chamar a operação DescribeRegions para consultar os IDs das regiões.	cn-hangzhou
IpamId	string	Sim	O ID da instância do IPAM.	ipam-ccxbnsbhew0d6t****
IpamScopeName	string	Não	O nome do escopo de IPAM. O nome deve ter de 1 a 128 caracteres e não pode começar com `http://` ou `https://`.	test
IpamScopeDescription	string	Não	A descrição do escopo de IPAM. A descrição deve ter de 1 a 256 caracteres e deve começar com uma letra. Não pode começar com `http://` ou `https://`. Se você não especificar este parâmetro, a descrição ficará vazia. O valor padrão é vazio.	test description
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o escopo de IPAM pertence.	rg-acfmxazb4ph6aiy****
DryRun	boolean	Não	Especifica se deve ser realizado um dry run para esta solicitação. Valores válidos: true: envia uma solicitação de verificação e não cria o escopo de IPAM. O sistema verifica se o seu par de AccessKey é válido, a autorização do usuário do Resource Access Management (RAM) e se os parâmetros obrigatórios foram especificados. Se a verificação falhar, o erro correspondente será retornado. Se a verificação for bem-sucedida, o código de erro `DryRunOperation` será retornado. false (padrão): envia uma solicitação normal. Se a verificação for bem-sucedida, um código de status HTTP 2xx será retornado e o escopo de IPAM será criado.	false
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação. Você pode usar o cliente para gerar o token, mas deve garantir que o token seja exclusivo entre várias solicitações. O token de cliente pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o RequestId da solicitação de API como o token de cliente. O RequestId de cada solicitação de API é exclusivo.	123e4567-e89b-12d3-a456-426655440000
IpamScopeType	string	Não	O tipo do escopo de IPAM. Valor válido: private. Nota Atualmente, apenas escopos privados podem ser criados.	private
Tag	array<object>	Não	A lista de tags.
	object	Não	A lista de tags.
Key	string	Não	A chave da tag do recurso. Você pode especificar até 20 chaves de tag. A chave da tag não pode ser uma string vazia. A chave da tag pode ter até 64 caracteres e deve começar com uma letra ou um caractere chinês. Pode conter dígitos, pontos (.), sublinhados (_) e hifens (-). Não pode começar com `aliyun` ou `acs:` e não pode conter `http://` ou `https://`.	FinanceDept
Value	string	Não	O valor da tag do recurso. Você pode especificar até 20 valores de tag. O valor da tag pode ser uma string vazia. O valor da tag pode ter até 128 caracteres e não pode conter `http://` ou `https://`.	FinanceJoshua

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A lista de informações retornadas.
RequestId	string	O ID da solicitação.	E897D16A-50EB-543F-B002-C5A26AB818FF
IpamScopeId	string	O ID da instância do escopo de IPAM.	ipam-scope-glfmcyldpm8lsy****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "E897D16A-50EB-543F-B002-C5A26AB818FF",
  "IpamScopeId": "ipam-scope-glfmcyldpm8lsy****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ResourceNotFound.Ipam	The specified resource of ipam is not found.	O IPAM especificado não existe.
400	UnsupportedFeature.PublicIpamScopeType	The feature of PublicIpamScopeType is not supported.	Atualmente, o IPAM especificado não oferece suporte à criação de escopos públicos.
400	QuotaExceeded.IpamScopeQuotaPerIpam	The quota of ipamScopeQuotaPerIpam count is exceeded.	O número máximo permitido de escopos do IPAM foi excedido.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	A validação DryRun foi aprovada.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.