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

Cria um endpoint de gateway.

Descrição da operação

CreateVpcGatewayEndpoint é uma operação assíncrona. Após o envio de uma solicitação, o sistema retorna um EndpointId e executa a tarefa em segundo plano. Você pode chamar a operação ListVpcGatewayEndpoints para consultar o status da tarefa.
- Se o endpoint de gateway estiver no estado Creating, o endpoint de gateway está sendo criado.
- Se o endpoint de gateway estiver no estado Created, o endpoint de gateway foi criado.
Você não pode chamar repetidamente a operação CreateVpcGatewayEndpoint para o mesmo serviço de endpoint dentro do período de tempo especificado.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
VpcId	string	Sim	O ID da nuvem privada virtual (VPC) onde você deseja criar o endpoint de gateway. A VPC e o endpoint de gateway devem ser implantados na mesma região.	vpc-bp1gsk7h12ew7oegk****
ServiceName	string	Sim	O nome do serviço de endpoint.	com.aliyun.cn-hangzhou.oss
PolicyDocument	string	Não	A política de acesso para o serviço em nuvem. Para obter mais informações sobre a sintaxe e a estrutura da política de acesso, consulte Sintaxe e estrutura da política.	{ "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "" ], "Action" : [ "" ], "Principal" : [ "*" ] } ] }
EndpointName	string	Não	O nome do endpoint de gateway. O nome deve ter de 1 a 128 caracteres.	test
EndpointDescription	string	Não	A descrição do endpoint de gateway. A descrição deve ter de 1 a 255 caracteres.	test
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 diferentes solicitações. O token pode conter apenas caracteres ASCII. Nota Se você não especificar este parâmetro, o sistema usará automaticamente o ID da solicitação como o token de cliente. O ID da solicitação pode ser diferente para cada solicitação.	5A2CFF0E-5718-45B5-9D4D-70B3FF3898
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run, sem executar a solicitação real. Valores válidos: true: realiza apenas um dry run. O sistema verifica a solicitação quanto a possíveis problemas, incluindo valores de parâmetros ausentes, sintaxe de solicitação incorreta e limites de serviço. 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 executa a solicitação real. Se a solicitação passar no dry run, um código de status HTTP 2xx será retornado e a operação será executada.	false
ResourceGroupId	string	Não	O ID do grupo de recursos ao qual o endpoint de gateway pertence.	rg-acfmxazb4ph****
Tag	array<object>	Não	As tags do recurso.
	object	Não
Key	string	Não	A chave da tag N a ser adicionada ao 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é 128 caracteres. 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 N a ser adicionado ao 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://`. O valor da tag não pode começar com `aliyun` ou `acs:`.	FinanceJoshua
RegionId	string	Sim	O ID da região do endpoint de gateway. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	62CFC815-E08A-5CF4-92D1-54273EC9E406
EndpointId	string	O ID do endpoint de gateway.	vpce-bp1w1dmdqjpwul0v3****
ServiceName	string	O nome do serviço de endpoint.	com.aliyun.cn-hangzhou.oss
EndpointName	string	O nome do endpoint de gateway.	test
CreationTime	string	A hora em que o endpoint de gateway foi criado. A hora segue o padrão ISO 8601 no formato AAAA-MM-DDThh:mm:ssZ. A hora é exibida em UTC.	2021-08-27T01:58:37Z
ResourceGroupId	string	O ID do grupo de recursos ao qual o endpoint de gateway pertence.	rg-acfmxazb4ph****

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "62CFC815-E08A-5CF4-92D1-54273EC9E406",
  "EndpointId": "vpce-bp1w1dmdqjpwul0v3****",
  "ServiceName": "com.aliyun.cn-hangzhou.oss",
  "EndpointName": "test",
  "CreationTime": "2021-08-27T01:58:37Z",
  "ResourceGroupId": "rg-acfmxazb4ph****"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	OperationFailed.ConcurrentOperation	The operation is failed because of concurrent operation.
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
400	IllegalParam.PolicyDocument	The param of PolicyDocument is illegal.
400	IllegalParam.GatewayEndpointName	The param of GatewayEndpointName is illegal.
400	IllegalParam.GatewayEndpointDescription	The param of GatewayEndpointDescription is illegal.
400	ResourceAlreadyExist.GatewayEndpoint	The specified resource gateway endpoint is already exist.
400	ResourceNotFound.ServiceName	The specified resource service name is not found.
400	ResourceNotFound.VpcId	The specified resource vpc is not found.
400	Forbidden.OperateShareResource	The operation is failed because of shared vpc.
400	IncorrectStatus.Vpc	The status of vpc [%s] is incorrect.
400	IncorrectStatus.CenStatus	The status of vpc cenStatus [%s] is incorrect.
400	OperationFailed.VpcIpv6Disabled	The operation is failed because of VpcIpv6Disabled.
400	UnsupportedFeature.GatewayEndpoint	The feature of gatewayEndpoint is not supported for %s.
400	SystemBusy	System is busy, please try again later.
400	Forbbiden	User not authorized to operate on the specified resource.
400	OperationDenied.PolicyDocument	The gatewayEndpoint does not support policy.
400	MissingParam.PolicyDocument	The param of PolicyDocument is missing.
400	OperationDenied.NotAuthorized	User not authorized to operate on the specified resource.
400	InvalidPolicy.WrongFormat	Invalid input policy format.	The format of the policy information is invalid.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.