Consulta de conexões de um serviço do VPC Endpoint
Função
Função Essa API é usada para consultar conexões de um serviço de ponto de extremidade da VPC. O marker_id é o ID exclusivo de cada conexão.
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. Mínimo: 1 |
| vpc_endpoint_service_id | Sim | String | Especifica o ID do serviço do ponto de extremidade da VPC. |
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| id | Não | String | Especifica o ID exclusivo do ponto de extremidade da VPC. |
| marker_id | Não | String | Especifica o ID do pacote do ponto de extremidade da VPC. |
| status | Não | String | Especifica o status da conexão do ponto de extremidade da VPC. ● pendingAcceptance: a conexão do ponto de extremidade da VPC deve ser aceita. ● creating: s conexão do ponto de extremidade da VPC está sendo criada. ● accepted: a conexão do ponto de extremidade da VPC foi aceita. ● failed: a conexão do ponto de extremidade da VPC falhou. |
| sort_key | Não | String | Especifica o campo de classificação dos pontos de extremidade da VPC, que pode ser: ●create_at: os pontos de extremidade da VPC são classificados por hora de criação. ●update_at: os pontos 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 pontos de extremidade da VPC, que pode ser: ● desc: os pontos de extremidade da VPC são classificados em ordem decrescente. ● asc: os pontos de extremidade da VPC são classificados em ordem crescente. O método padrão é desc. Padrão: desc |
| limit | Não | Integer | Especifica o número máximo de conexões exibidas 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 | Inteiro | 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 |
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. |
| 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. |
Parâmetros de resposta
Código de estado: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| connections | Array of ConnectionEndpoints objects | Lista as conexões. |
| total_count | Integer | Especifica o número total de pontos de extremidade da VPC 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 | Especifica o ID exclusivo do ponto de extremidade da VPC. |
| marker_id | Inteiro | Especifica o ID do pacote do ponto de extremidade da VPC. |
| created_at | String | Especifica o horário de criação de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ. |
| updated_at | String | Especifica o horário de atualização de ponto de extremidade da VPC. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ. |
| domain_id | String | ID de domínio de um usuário. |
| error | Array of QueryError objects | Especifica a mensagem de erro. Esse campo é retornado quando o ponto de extremidade da VPC é anormal, ou seja, o valor de status é failed. |
| status | String | Especifica o status da conexão do ponto de extremidade da VPC. ● pendingAcceptance: a conexão do ponto de extremidade da VPC deve ser aceita. ● creating: s conexão do ponto de extremidade da VPC está sendo criada. ● accepted: a conexão do ponto de extremidade da VPC foi aceita. ● rejected: a conexão do ponto de extremidade da VPC foi rejeitada. ● failed: a conexão do ponto de extremidade da VPC falhou. ● deleting: a conexão do ponto de extremidade da VPC está sendo criada. |
| description | String | Especifica a descrição de uma conexão do ponto de extremidade da VPC. |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_message | String | Mensagem de erro. |
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. |
Exemplo de solicitações
GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/connections? id={vpc_endpoint_id}&marker_id={marker_id}&status={status}&sort_key={sort_key }&sort_dir={sort_dir}&limit={limit}&offset={offset} This request is to query connections of the VPC endpoint service whose ID is 4189d3c2-8882-4871-a3c2-d380272eed88. GET https://{endpoint}/v1/{project_id}/vpc-endpoint-services/4189d3c2-8882-4871-a3c2-d380272eed88/connections Exemplo de respostas
Código de estado: 200
O servidor processou a solicitação com sucesso.
{ "connections" : [ { "id" : "adb7b229-bb11-4072-bcc0-3327cd784263", "status" : "accepted", "marker_id" : 16777510, "domain_id" : "5fc973eea581490997e82ea11a1df31f", "created_at" : "2018-09-17T11:10:11Z", "updated_at" : "2018-09-17T11:10:12Z" }, { "id" : "fd69d29f-dc29-4a9b-80d8-b51d1e7e58ea", "status" : "accepted", "marker_id" : 16777513, "domain_id" : "5fc973eea581490997e82ea11a1df31f", "created_at" : "2018-09-17T07:28:56Z", "updated_at" : "2018-09-17T07:28:58Z" } ], "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 | A página solicitada não foi encontrada. |
| 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.