Consulta de serviços do VPC Endpoint público
Função
Função Essa API é usada para consultar serviços do ponto de extremidade da VPC público. Esses serviços são criados pela equipe de O&M e podem ser visíveis e acessados por todos os usuários.
URI
GET /v1/{project_id}/vpc-endpoint-services/public
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
project_id |
Sim |
String |
ID do projeto. Mínimo: 1 Máximo: 64 |
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
limit |
Não |
Integer |
Especifica o número máximo de serviços do ponto de extremidade da VPC público exibidos em cada página. O valor varia de 0 a 1000 e geralmente é 10, 20 ou 50. O número padrão é 10. Mínimo: 1 Máximo: 1000 Padrão: 10 |
offset |
Não |
Integer |
Especifica o deslocamento. Todos os serviços do ponto de extremidade da VPC após esse deslocamento serão consultados. O deslocamento deve ser um número inteiro maior que 0, mas menor que o número de serviços do ponto de extremidade da VPC. Mínimo: 0 |
endpoint_service_name |
Não |
String |
Especifica o nome do serviço do ponto de extremidade da VPC. O valor não diferencia maiúsculas de minúsculas e suporta correspondência difusa. Mínimo: 1 Máximo: 128 |
id |
Não |
String |
ID exclusivo do serviço do ponto de extremidade da VPC público. Mínimo: 1 Máximo: 64 |
sort_key |
Não |
String |
Especifica o campo de classificação dos serviços do ponto de extremidade da VPC, que pode ser: ● create_at: os serviços do ponto de extremidade da VPC são classificados por hora de criação. ● update_at: os serviços do ponto de extremidade da VPC são classificados por hora de atualização. O campo padrão é create_at. Padrão: create_at |
sort_dir |
Não |
String |
Especifica o método de classificação dos serviços do ponto de extremidade da VPC, que pode ser: ● desc: os serviços do ponto de extremidade da VPC são classificados em ordem decrescente. ● asc: os serviços do ponto de extremidade da VPC são classificados em ordem crescente. O método padrão é desc. Padrão: desc |
Parâmetros de solicitação
Parâmetro |
Obrigatoriedade |
Tipo |
Descrição |
---|---|---|---|
X-Auth-Token |
Sim |
String |
Especifica o token do usuário. Ele pode ser obtido chamando a API do IAM. O valor de X-Subject-Token no cabeçalho da resposta é o token do usuário. Mínimo: 1 Máximo: 2048 |
Content-Type |
Sim |
String |
Especifica o tipo MIME do corpo da solicitação. O valor padrão application/json é recomendado. Para as API usadas para carregar objetos ou imagens, o tipo MIME pode variar dependendo do tipo de fluxo. Mínimo: 1 Máximo: 64 |
Parâmetros de resposta
Código de estado: 200
Parâmetro |
Tipo |
Descrição |
---|---|---|
endpoint_services |
Array of EndpointService objects |
Lista os serviços do ponto de extremidade da VPC. |
total_count |
Integer |
Especifica o número total de serviços do ponto de extremidade da VPC público que atendem aos critérios de pesquisa. O número não é afetado pelos parâmetros limite e offset. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID exclusivo do serviço do ponto de extremidade da VPC público. |
owner |
String |
Especifica o tipo do serviço do ponto de extremidade da VPC. |
service_name |
String |
Especifica o nome do serviço do ponto de extremidade da VPC. |
service_type |
String |
Especifica o tipo do serviço do ponto de extremidade da VPC. ● gateway: os serviços do ponto de extremidade de VPC desse tipo são configurados pelo pessoal de O&M. Você pode usá-los diretamente sem criá-los por si mesmos. ● interface: os serviços de nuvem configurados pelo pessoal de O&M e serviços privados criados por você estão incluídos. Você não pode configurar esses serviços de nuvem, mas pode usá-los. Você pode criar um ponto de extremidade da VPC para acessar os serviços de gateway e interface do ponto de extremidade da VPC. |
created_at |
String |
Especifica o horário de criação do serviço do ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAAMM-DDTHH:MM:SSZ. |
is_charge |
Boolean |
Especifica se o ponto de extremidade da VPC associado carrega uma cobrança. ● true: o ponto de extremidade da VPC associado precisa ser cobrado. ● false: o ponto de extremidade da VPC associado não precisa ser cobrado. |
Código de estado: 400
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 401
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 403
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 404
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 405
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 406
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 407
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 408
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 409
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 500
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 501
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 502
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 503
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Código de estado: 504
Parâmetro |
Tipo |
Descrição |
---|---|---|
error |
Error object |
Especifica a mensagem de erro retornada quando ocorre uma exceção de envio de tarefa. |
Parâmetro |
Tipo |
Descrição |
---|---|---|
message |
String |
Descrição do erro da tarefa |
code |
String |
Código de erro de uma exceção de tarefa. |
Exemplos de solicitações
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/public?limit={limit}&offset={offset}&endpoint_service_name={endpoint_service_name}&id={endpoint_service_id}&sort_key={sort_key}&sort_dir={sort_dir}
Exemplo de respostas
Código de estado: 200
O servidor processou a solicitação com sucesso.
{ "endpoint_services": [ { "id": "b0e22f6f-26f4-461c-b140-d873464d4fa0", "owner": "example" "service_name": "test123", "service_type": "interface", "created_at": "2018-09-10T13:13:23Z", "is_charge": "true" }, { "id": "26391a76-546b-42a9-b2fc-496ec68c0e4d", "owner": "example" "service_name": "OBS", "service_type": "gateway", "created_at": "2019-03-28T09:30:27Z", "is_charge": "true" } ], "total_count": 2 }
Códigos de estado
Código de estado |
Descrição |
---|---|
200 |
O servidor processou a solicitação com sucesso. |
400 |
A solicitação não pôde ser entendida pelo servidor devido à sintaxe mal formada. |
401 |
A página solicitada requer um nome de usuário e senha. |
403 |
O servidor entendeu o pedido, mas está se recusando a cumpri-lo. |
404 |
O servidor não encontrou nada que corresponda ao URI da solicitação. |
405 |
O método especificado na linha de solicitação não é permitido para o recurso identificado pelo URI da solicitação. |
406 |
O recurso identificado pela solicitação só é capaz de gerar entidades de resposta que tenham características de conteúdo não aceitáveis de acordo com os cabeçalhos de aceitação enviados na solicitação. |
407 |
O cliente deve primeiro autenticar-se com o proxy. |
408 |
O cliente não produziu uma solicitação dentro do tempo que o servidor estava preparado para esperar. |
409 |
A solicitação não pôde ser concluída devido a um conflito com o estado atual do recurso. |
500 |
Falhou ao concluir a solicitação. Anormalidade de serviço. |
501 |
Falhou ao concluir a solicitação. O servidor não suporta a função solicitada. |
502 |
Falhou ao concluir a solicitação. porque o servidor recebe uma resposta inválida. |
503 |
Falhou ao concluir a solicitação. porque o sistema não está disponível. |
504 |
Gateway expirou o tempo limite |
Códigos de erro
Consulte Códigos de erro.