DescribeServiceEndpoints - Platform For AI: Central de Documentação do Alibaba Cloud

Obtém uma lista de endpoints de serviço.

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.

Sintaxe da solicitação

GET /api/v2/services/{ClusterId}/{ServiceName}/endpoints HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClusterId	string	Não	O ID da região.	cn-hangzhou
ServiceName	string	Sim	O nome do serviço. Para mais informações, consulte ListServices.	service_name

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta.
RequestId	string	O ID da solicitação.	739998B5-FB39-12A3-8323-0FA340317298
Message	string	A mensagem retornada.	Execution succeeded.
AccessToken	string	O token do serviço.	Nzc5N2FhN**TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1**
Endpoints	array<object>	A lista de endpoints de serviço.
	object
EndpointType	string	O tipo de conexão do endpoint de serviço. Valores válidos: DefaultGateway: O serviço é conectado usando um gateway compartilhado. PrivateGateway: O serviço é conectado usando um gateway dedicado. Nlb: O serviço é anexado a uma instância de Network Load Balancer (NLB). Nacos: O serviço é anexado a uma instância do Nacos.	Nlb
BackendId	string	O ID do serviço de backend. O valor deste parâmetro varia de acordo com o valor de EndpointType: Se EndpointType for DefaultGateway, este parâmetro é definido como default. Se EndpointType for PrivateGateway, este parâmetro é o ID do gateway dedicado. Se EndpointType for Nlb, este parâmetro é o ID da instância do NLB. Se EndpointType for Nacos, este parâmetro é o ID da instância do Nacos.	nlb-5q4sp7u6oorkha****
PathType	string	O tipo do endpoint. Valores válidos: Group: O endpoint de um grupo público. Service: O endpoint de um serviço.	Service
IntranetEndpoints	array	A lista de endpoints internos.
	string	O endpoint interno.	nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com
InternetEndpoints	array	A lista de endpoints voltados para a Internet.
	string	O endpoint voltado para a Internet.	null
Port	integer	O número da porta. Este parâmetro é retornado apenas quando o serviço é anexado a uma instância de NLB ou Nacos.	9090

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "739998B5-FB39-12A3-8323-0FA340317298",
  "Message": "Execution succeeded.",
  "AccessToken": "Nzc5N2FhN****TQ0YzBmYTIyN2MxZTUxN2NkYjg4MTJmMWQxZmY1****",
  "Endpoints": [
    {
      "EndpointType": "Nlb",
      "BackendId": "nlb-5q4sp7u6oorkha****",
      "PathType": "Service",
      "IntranetEndpoints": [
        "nlb-5q4sp7u6oor****jvv.cn-hangzhou.nlb.aliyuncs.com"
      ],
      "InternetEndpoints": [
        "null"
      ],
      "Port": 9090
    }
  ]
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.