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

Chama a operação CreateVpcEndpointService para criar um serviço de endpoint.

Descrição da operação

Antes de criar um serviço de endpoint, certifique-se de ter criado um recurso de balanceamento de carga compatível com o PrivateLink. Para mais informações, consulte Criar uma instância de load balancer.
A operação CreateVpcEndpointService é assíncrona. Após enviar uma solicitação, o sistema retorna um ID de instância, mas o serviço de endpoint ainda não foi criado. O sistema continua a criar o serviço de endpoint como um nó em segundo plano. Você pode invocar GetVpcEndpointServiceAttribute para consultar o status de criação do serviço de endpoint:
- Se o serviço de endpoint estiver no estado Creating, o serviço de endpoint está sendo criado.
- Se o serviço de endpoint estiver no estado Active, o serviço de endpoint foi criado.

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

create

*VpcEndpointService

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

LoadBalancer

acs:alb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

LoadBalancer

acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

NatGateway

acs:vpc:{#regionId}:{#accountId}:natgateway/{#NatGatewayId}

LoadBalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Sim	O ID da região do serviço de endpoint. Você pode chamar DescribeRegions para consultar a lista de regiões mais recente.	cn-huhehaote
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.	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: true: realiza apenas um dry run. O sistema verifica a solicitação em busca de 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, um código de erro será retornado. 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
ServiceDescription	string	Não	A descrição do serviço de endpoint.	Este é meu EndpointService
AutoAcceptEnabled	boolean	Não	Especifica se as conexões de endpoint devem ser aceitas automaticamente. Valores válidos: true: aceita automaticamente as conexões de endpoint. false (padrão): não aceita automaticamente as conexões de endpoint.	false
Payer	string	Não	O pagador. Valores válidos: Endpoint: o consumidor do serviço. EndpointService: o provedor do serviço.	Endpoint
ZoneAffinityEnabled	boolean	Não	Especifica se há suporte para afinidade de zona para o nome de domínio de endpoint do serviço de endpoint. Valores válidos: true: sim. false (padrão): não.	false
ServiceResourceType	string	Não	O tipo de recurso EPS. Valores válidos: slb: Classic Load Balancing (CLB). alb: Application Load Balancing (ALB). nlb: Network Load Balancing (NLB). gwlb: Gateway Load Balancer (GWLB). Nota Não há suporte para acesso a listeners TCPSSL do NLB.	slb
Resource	array<object>	Não	Os recursos de serviço do serviço de endpoint. Você pode adicionar até 10 recursos ao criar o serviço de endpoint. É possível adicionar mais recursos após a criação do serviço de endpoint.
	object	Não	Os recursos de serviço do serviço de endpoint.
ResourceType	string	Não	O tipo de recurso EPS a ser adicionado ao serviço de endpoint. Você pode adicionar até 20 recursos de serviço a um serviço de endpoint. Valores válidos: slb: Classic Load Balancing (CLB). alb: Application Load Balancing (ALB). nlb: Network Load Balancing (NLB). gwlb: Gateway Load Balancer (GWLB).	slb
ResourceId	string	Não	O ID do recurso de serviço a ser adicionado ao serviço de endpoint.	lb-hp32z1wp5peaoox2q****
ZoneId	string	Não	O ID da zona.	cn-huhehaote-a
RegionId	string	Sim	Especifica se o serviço de endpoint oferece suporte a IPv6. Valores válidos: true: sim. false (padrão): não.	false
ServiceSupportIPv6 `deprecated`	boolean	Não	O ID do grupo de recursos.	rg-acfmy*****
ResourceGroupId	string	Não	A lista de tags.	rg-acfmy*****
Tag	array<object>	Não	A versão do protocolo. Valores válidos: IPv4: IPv4 (padrão). DualStack: pilha dupla. Nota Apenas serviços de endpoint cujo tipo de recurso de backend é nlb ou gwlb oferecem suporte ao protocolo de endereço IP DualStack. Se o serviço de endpoint oferecer suporte a pilha dupla, os recursos de backend também devem oferecer suporte a pilha dupla.	IPv4
	object	Não	A lista de tags.
Key	string	Não	A chave de tag da instância. Você pode especificar até 20 chaves de tag. A chave de tag não pode ser uma string vazia. A chave de tag pode ter até 64 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	env
Value	string	Não	O valor de tag da instância. Você pode especificar até 20 valores de tag. O valor de tag pode ser uma string vazia. O valor de tag pode ter até 128 caracteres e não pode começar com `aliyun` ou `acs:`. Não pode conter `http://` ou `https://`.	prod
AddressIpVersion	string	Não	A lista de regiões suportadas pelo serviço de endpoint. Os consumidores do serviço podem criar conexões de endpoint a partir das regiões nesta lista.	IPv4
SupportedRegionList	array	Não	A lista de regiões suportadas pelo serviço de endpoint. Os consumidores de serviço podem iniciar conexões de endpoint a partir das regiões na lista.
	string	Não	O ID da região suportada pelo serviço de endpoint.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
ServiceBusinessStatus	string	O status comercial do serviço de endpoint. Valores válidos: Normal: Normal. FinancialLocked: bloqueado devido a pagamento em atraso.	Normal
RequestId	string	O ID da solicitação.	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceName	string	O nome do serviço de endpoint.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	O status do serviço de endpoint. Valores válidos: Creating: sendo criado. Pending: sendo modificado. Active: disponível. Deleting: sendo excluído.	Active
ServiceDescription	string	A descrição do serviço de endpoint.	Este é meu EndpointService
CreateTime	string	A hora em que o serviço de endpoint foi criado.	2022-01-02T19:11:12Z
ServiceDomain	string	O nome de domínio de serviço do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
ZoneAffinityEnabled	boolean	Indica se há suporte para afinidade de zona para o nome de domínio de endpoint do serviço de endpoint. Valores válidos: true: sim. false: não.	false
AutoAcceptEnabled	boolean	Indica se o serviço de endpoint está configurado para aceitar automaticamente conexões de endpoint. Valores válidos: true: O serviço de endpoint aceita automaticamente conexões de endpoint. false: O serviço de endpoint não aceita automaticamente conexões de endpoint.	false
ServiceId	string	O ID do serviço de endpoint.	epsrv-hp3vpx8yqxblby3i****
ServiceSupportIPv6 `deprecated`	boolean	Indica se o serviço de endpoint oferece suporte a IPv6. Valores válidos: true: sim. false: não.	false
ResourceGroupId	string	O ID do grupo de recursos.	rg-acfmy*****
AddressIpVersion	string	A versão do protocolo. Valores válidos: IPv4: IPv4. DualStack: pilha dupla.	IPv4
SupportedRegionSet	array<object>	A lista de regiões suportadas pelo serviço de endpoint. Os consumidores do serviço podem criar conexões de endpoint a partir das regiões nesta lista.
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	O status da região suportada pelo serviço de endpoint. Valores válidos: Pending: sendo modificado. Available: disponível. Deleting: sendo excluído. Failed: falhou. Closed: fechado.	Available
RegionBusinessStatus	string	O status comercial da região suportada pelo serviço de endpoint. Valores válidos: Normal: Normal. FinancialLocked: bloqueado devido a pagamento em atraso.	Normal
SupportedRegionId	string	O ID da região suportada pelo serviço de endpoint.	cn-hangzhou

Exemplos

Resposta de sucesso

JSON formato

{
  "ServiceBusinessStatus": "Normal",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus": "Active",
  "ServiceDescription": "This is my EndpointService.",
  "CreateTime": "2022-01-02T19:11:12Z",
  "ServiceDomain": "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "ZoneAffinityEnabled": false,
  "AutoAcceptEnabled": false,
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
400	EndpointServiceExist	The specified Endpoint Service already exists.
400	AlbNotFound	The specified Alb does not exist.
400	LoadBalancerNotFound	The specified load balancer does not exist.
400	LoadBalancerNotSupportPrivateLink	The specified SLB does not support PrivateLink.
400	GenerateResourceIdFailed	Failed to generate ResourceId.
400	QuotaMisMatched	The resource you applied for has exceeded the quota.
400	VSwitchNotFound	The specified VSwitch does not exist.
400	EndpointServicePayerForbidden	The parameter EndpointServicePayer is forbidden. The user is not in the whitelist.
400	NeedOpenProduct	The product is not activated.
400	EndpointServiceNotSupportedZone	The specified endpoint service does not support the zone.
400	IllegalParamFormat.%s	The param format of %s is illegal.
400	MissingParam.%s	The param of %s is missing.
400	ResourceNotFound.NatGateway	The specified resource %s is not found.
400	Mismatch.ResourceType	The %s is mismatched for %s and %s.
400	EndpointServiceNotSupportIpv6	The param supportIpv6 of EndpointService is forbidden , resource is not support ipv6.
400	OperationDenied.PrivateDomainNotSupport	The operation is not allowed because of PrivateDomainNotSupport.
400	Conflict.ServiceName	The ServiceName %s is conflict.
400	InvalidParam.PrivateDnsName	The parameter of PrivateDnsName is illegal, which needs to end with aliyun.com, aliyun-inc.com, or aliyuncs.com.
400	OperationDenied.ZoneAffinityNotSupport	The operation is not allowed because of zone affinity not support.
400	OperationDenied.RamPolicyNotSupport	The operation is not allowed because of RamPolicyNotSupport.
400	OperationDenied.ResourceTypeNotSupportDualStack	The specified resource type does not support dualstack.
400	OperationDenied.ServiceResourceIpVersionMismatch	The endpoint service and service resource AddressIpVersion do not match.
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.