CreateVpcEndpoint - PrivateLink: Central de Documentação do Alibaba Cloud

Cria um endpoint.

Descrição da operação

CreateVpcEndpoint é uma operação assíncrona. Após o envio de uma solicitação, o sistema retorna um ID de instância, mas o endpoint ainda não foi criado. O processamento em segundo plano ainda está em andamento. Você pode invocar GetVpcEndpointAttribute para consultar o status de criação do endpoint:

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

privatelink:CreateVpcEndpoint

create

*VpcEndpoint

acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/*

*SecurityGroup

acs:ecs:{#regionId}:{#accountId}:securitygroup/{#SecurityGroupId}

*VSwitch

acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

*VPC

acs:vpc:{#regionId}:{#accountId}:vpc/{#VpcId}

privatelink:VpcEndpointServiceId

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do endpoint.	cn-huhehaote.
ClientToken	string	Não	O token de cliente usado para garantir a idempotência da solicitação.	0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRun	boolean	Não	Especifica se deve ser realizado apenas um dry run, sem executar a solicitação real. Valores válidos:	false.
EndpointName	string	Não	O nome do endpoint.	test.
EndpointType	string	Não	O tipo de endpoint. Valores válidos:	Interface.
ZonePrivateIpAddressCount	integer	Não	O número de endereços IP privados para a ENI em cada zona. Defina o valor como 1.	1
EndpointDescription	string	Não	A descrição do endpoint.	This is my Endpoint.
VpcId	string	Sim	A VPC à qual o endpoint pertence.	vpc-hp356stwkxg3fn2xe****
ServiceId	string	Não	O serviço de endpoint associado ao endpoint.	epsrv-hp3xdsq46ael67lo****
ServiceName	string	Não	O nome do serviço de endpoint associado ao endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
Zone	array<object>	Não	As zonas do endpoint.
	object	Não	O ID da zona na região atual.
VSwitchId	string	Não	O vSwitch na zona onde você deseja criar uma interface de rede elástica (ENI) de endpoint.	vsw-hp3uf6045ljdhd5zr****
ZoneId	string	Não	A zona do endpoint.	cn-huhehaote-b.
ip	string	Não	O endereço IPv4 da interface de rede elástica (ENI) de endpoint na zona de endpoint especificada.	192.168.XX.XX
Ipv6Address	string	Não	O endereço IPv6 da interface de rede elástica (ENI) de endpoint na zona de endpoint especificada.	2408:4005:34d:**:a58b:62a3:6b55:**
SecurityGroupId	array	Não	Os grupos de segurança associados à interface de rede elástica (ENI) de endpoint.	sg-hp33bw6ynvm2yb0e****
	string	Não	O grupo de segurança associado à interface de rede elástica (ENI) de endpoint. O grupo de segurança controla a comunicação de dados da VPC para a interface de rede elástica (ENI) de endpoint.	sg-bp1fg655nh68xyz9****
ProtectedEnabled	boolean	Não	Especifica se a proteção gerenciada deve ser ativada. Este parâmetro entra em vigor apenas quando a solicitação é feita usando o Security Token Service (STS). Valores válidos:	false.
RegionId	string	Sim	As tags.	cn-huhehaote
Tag	array<object>	Não	O ID do grupo de recursos.	rg-acfmy*****
	object	Não	As tags.
Key	string	Não	A chave da tag.	env
Value	string	Não	O valor da tag.	prod
ResourceGroupId	string	Não	A política de acesso do RAM. Para mais informações sobre a definição da política, consulte Elementos de política.	{
PolicyDocument	string	Não	A versão do protocolo. Valores válidos:	IPv4
AddressIpVersion	string	Não	Especifica se deve haver suporte à afinidade de zona para o nome de domínio do endpoint ao conectar-se ao serviço. Valores válidos:	false.
ZoneAffinityEnabled	boolean	Não	O ID da região do serviço de endpoint. O valor padrão é a região atual, que é a região onde você cria um endpoint.	cn-huhehaote.
ServiceRegionId	string	Não	O valor da largura de banda entre regiões. Este parâmetro é obrigatório apenas quando o endpoint e o serviço de endpoint estão em regiões diferentes. Unidade: Mbps. Valores válidos:	1000
CrossRegionBandwidth	integer	Não	A largura de banda entre regiões. Este parâmetro é necessário apenas quando o endpoint e o serviço de endpoint estão em regiões diferentes. Unidade: Mbps. Valores válidos: Valor padrão: 1000 para conexões entre regiões dentro da China continental. 100 para outros cenários. Valor mínimo: 100. Valor máximo: sujeito à cota da sua conta. Para obter mais informações, consulte Cotas e limites. Nota Especifique este parâmetro apenas ao criar um endpoint entre regiões.	1000

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
EndpointDomain	string	O nome de domínio do endpoint.	ep-hp33b2e43fays7s8**.epsrv-hp3xdsq46ael67lo**.cn-huhehaote.privatelink.aliyuncs.com.
RequestId	string	O ID da solicitação.	0ED8D006-F706-4D23-88ED-E11ED28DCAC0
CreateTime	string	A hora em que o endpoint foi criado.	2022-01-02T19:11:12Z
EndpointBusinessStatus	string	O status comercial do endpoint. Valores válidos:	Normal.
EndpointDescription	string	A descrição do endpoint.	This is my Endpoint.
ServiceId	string	O ID do serviço de endpoint associado ao endpoint.	epsrv-hp3vpx8yqxblby3i****
EndpointStatus	string	O status do endpoint. Valores válidos:	Active.
VpcId	string	A VPC à qual o endpoint pertence.	vpc-hp356stwkxg3fn2xe****
EndpointName	string	O nome do endpoint.	test.
ServiceName	string	O nome do serviço de endpoint associado ao endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
Bandwidth	integer	A largura de banda de conexão do endpoint. Unidade: Mbps.	200
EndpointId	string	O ID do endpoint.	ep-hp33b2e43fays7s8****
ConnectionStatus	string	O status de conexão do endpoint. Valores válidos:	Disconnected.
AddressIpVersion	string	A versão do protocolo. Valores válidos:	IPv4
ZoneAffinityEnabled	boolean	Especifica se deve haver suporte à afinidade de zona para o nome de domínio do endpoint ao conectar-se ao serviço. Valores válidos:	false.
ServiceRegionId	string	O ID da região do serviço de endpoint.	cn-huhehaote.
CrossRegionBandwidth	integer	O valor da largura de banda entre regiões do endpoint. Este parâmetro é aplicável apenas quando o endpoint e o serviço de endpoint estão em regiões diferentes. Unidade: Mbps.	1000

Exemplos

Resposta de sucesso

JSON formato

{
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "CreateTime": "2022-01-02T19:11:12Z",
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-hp356stwkxg3fn2xe****",
  "EndpointName": "test",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 200,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "ConnectionStatus": "Disconnected",
  "AddressIpVersion": "IPv4",
  "ZoneAffinityEnabled": false,
  "ServiceRegionId": "cn-huhehaote",
  "CrossRegionBandwidth": 1000
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	EndpointExist	The specified Endpoint already exists.
400	EndpointZoneDuplicated	The zone is duplicated for the Endpoint.
400	EndpointServiceNotFound	The specified Service does not exist.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	SecurityGroupNotFound	The specified security group does not exist.
400	VpcTunnelNotFound	The specified VPC tunnel does not exist.
400	VpcNotFound	The specified VPC does not exist.
400	GenerateResourceIdFailed	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.
400	EndpointMustContainSecurityGroup	The specified endpoint must have at least one security group.
400	EndpointDuplicated	The endpoint of the service already exists and cannot be created again.
400	EndpointServiceDeleted	The specified Service is already deleted.
400	EndpointServiceResourceNotFound	The specified service resource is not found.
400	SecurityGroupTypeNotSupport	The specified security group type is not supported.
400	EniIpUnavailable	The specified IP address is unavailable.
400	EndpointServiceNotAuthorized	The specified endpoint service is not authorized to user.
400	SecurityGroupTypeOnlySingleTypeSupporteded	The specified security group only support one type.
400	QuotaExceeded.IpQuotaPerEp	The quota of %s is exceeded, usage %s/%s.
400	Mismatch.EndpointType	The %s is mismatched for %s and %s.
400	IncorrectStatus.VpcEndpointService	The status of %s [%s] is incorrect.
400	CheckServiceLinkRoleError	The ServiceLink role check error.
400	ResourceNotEnough.VSwitchIp	The specified resource of VSwitchIp is not enough.
400	VSwitchStatusNotAllowed	The specified vswitch status is not Available.
400	QuotaExceeded.epZonePerEndpoint	The quota of %s is exceeded, usage %s/%s.
400	QuotaExceeded.totalEpPerVpc	The quota of %s is exceeded, usage %s/%s.
400	QuotaExceeded.totalIdleEndpoint	The quota of %s is exceeded, usage %s/%s.
400	OperationDenied.EndpointPolicyNotSupport	The operation is not allowed because of EndpointPolicyNotSupport.
400	OperationDenied.PrivateDomainStatusNotSupport	The operation is not allowed because of %s.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	DependencyViolation.PrivateDnsName	The specified resource of %s depends on %s, so the operation cannot be completed.
400	GatewayLoadBalancerNotSupportSecurityGroup	The gateway load balancer not support security group.
400	GatewayLoadBalancerZoneCountDeny	The GatewayLoadBalancer zone count not support
400	OperationDenied.EndpointTypeNotSupportDualstack	The specified endpoint type does not support dualstack, only the Interface and GatewayLoadBalancer types support dual stack.
400	OperationDenied.EndpointServiceNotSupportDualstack	The specified endpoint service does not support dualstack.
400	OperationDenied.VSwitchNotSupportDualstack	The specified VSwitch does not support dualstack.
400	OperationDenied.AddressIpVersionNotSupportSpecifyIpv6	The AddressIpVersion of the endpoint does not support specifying IPv6 address.
400	IllegalParam.Ip	The specified parameter IP is invalid.
400	IllegalParam.Ipv6Address	The specified parameter Ipv6Address is invalid.
400	IllegalParam.AddressIpVersion	The specified parameter AddressIpVersion is invalid.
400	SpecifiedAlbNotSupport	The specified alb %s is not supported.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.