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

Cria uma instância IPAM.

Descrição da operação

Cada conta Alibaba Cloud pode criar apenas uma instância IPAM em cada região.
Atualmente, o IPAM suporta apenas a alocação de endereços IPv4.
Ao criar uma instância IPAM:
- Se não existir nenhuma instância de descoberta de recursos personalizada na região atual, o sistema cria automaticamente uma instância de descoberta de recursos padrão e a associa à instância IPAM.
- Se já existir uma instância de descoberta de recursos personalizada na região atual, o sistema a converte em uma instância de descoberta de recursos padrão e a associa à instância IPAM.

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:CreateIpam

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 hospedeira da instância IPAM. Você pode chamar a operação DescribeRegions para consultar os IDs das regiões.	cn-hangzhou
IpamName	string	Não	O nome da instância IPAM. O nome deve ter de 1 a 128 caracteres e não pode começar com `http://` ou `https://`.	abc
OperatingRegionList	array	Sim	A lista de regiões efetivas para a instância IPAM.
	string	Não	A região efetiva da instância IPAM. Nota Você pode especificar uma ou mais regiões.	cn-hangzhou
IpamDescription	string	Não	A descrição da instância IPAM. A descrição deve ter de 1 a 256 caracteres e deve começar com uma letra ou um caractere chinês. Não pode começar com `http://` ou `https://`. Se você não especificar este parâmetro, a descrição ficará vazia. Valor padrão: vazio.	This is my first Ipam
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual a instância IPAM pertence.	rg-acfmxazb4ph6aiy****
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run na solicitação. Valores válidos: true: realiza um dry run sem criar a instância IPAM. O sistema verifica se os parâmetros obrigatórios foram especificados, se o formato da solicitação é válido e se os limites do serviço foram atendidos. Se a solicitação falhar no dry run, uma mensagem de erro será retornada. Se a solicitação passar no dry run, o código de erro DryRunOperation será retornado. false (padrão): realiza um dry run e envia a solicitação. Se a solicitação passar no dry run, o sistema retorna um código de status HTTP 2xx e cria a instância IPAM.	false
ClientToken	string	Não	O token do 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 diferentes solicitações. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usa automaticamente o RequestId da solicitação de API como o token do cliente. O RequestId de cada solicitação de API é diferente.	123e4567-e89b-12d3-a456-426655440000
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.	0ED8D006-F706-4D23-88ED-E11ED39DCAC0
IpamId	string	O ID da instância do IPAM.	ipam-ccxbnsbhew0d6t****
PrivateDefaultScopeId	string	O ID do escopo privado padrão do IPAM criado pelo sistema após a criação da instância IPAM.	ipam-scope-8wiontzmiy6cg0****
PublicDefaultScopeId	string	O ID do escopo público padrão do IPAM criado pelo sistema após a criação da instância IPAM.	ipam-scope-r5c5c7bmym1brc****
DefaultResourceDiscoveryId	string	O ID da instância da descoberta de recursos padrão.	ipam-res-disco-jt5f2af2u6nk2z321****
DefaultResourceDiscoveryAssociationId	string	O ID da associação de descoberta de recursos padrão.	ipam-res-disco-assoc-jt5fac8twugdbbgip****
ResourceDiscoveryAssociationCount	integer	O número de associações de descoberta de recursos.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED39DCAC0",
  "IpamId": "ipam-ccxbnsbhew0d6t****",
  "PrivateDefaultScopeId": "ipam-scope-8wiontzmiy6cg0****",
  "PublicDefaultScopeId": "ipam-scope-r5c5c7bmym1brc****",
  "DefaultResourceDiscoveryId": "ipam-res-disco-jt5f2af2u6nk2z321****",
  "DefaultResourceDiscoveryAssociationId": "ipam-res-disco-assoc-jt5fac8twugdbbgip****",
  "ResourceDiscoveryAssociationCount": 1
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	UnsupportedRegion.Ipam	Ipam is not supported in this region.	O IPAM não é suportado nesta região.
400	QuotaExceeded.IpamQuotaPerRegion	The quota of ipamQuotaPerRegion count is exceeded.	O número máximo permitido de IPAMs foi excedido.
400	IllegalParam.OperatingRegion	The operating region is invalid.	A região efetiva é inválida.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	A validação DryRun foi aprovada.
400	OperationFailed.OperatingRegionsNeedIncludeIpamRegion	The operating regions do not contain IPAM region.	A região da operação não inclui a região de hospedagem do IPAM.
400	UnsupportedFeature.Ipam	IPAM is not supported in this region.	O recurso IPAM não é suportado nesta região.
400	OptInRequired.Ipam	You are not authorized to use the requested service of IPAM. Ensure that you have subscribed to the service you are trying to use.	Você não está autorizado a usar o serviço IPAM solicitado. Certifique-se de ter assinado o serviço que está tentando usar.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.