Consulta de registros da lista branca de um serviço do VPC Endpoint
Função
Função Essa API é usada para consultar os registros da lista de permissões de um serviço do ponto de extremidade da VPC. Observação: sua conta está na lista branca do seu próprio serviço do ponto de extremidade da VPC por padrão.
URI
GET /v1/{project_id}/vpc-endpoint-services/{vpc_endpoint_service_id}/permissions
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. Mínimo: 1 Máximo: 64 |
| vpc_endpoint_service_id | Sim | String | Especifica o ID do serviço do ponto de extremidade da VPC. Mínimo: 1 Máximo: 64 |
| Parâmetro | Obrigatoriedade | Tipo | Descrição |
|---|---|---|---|
| permission | Não | String | Especifica o ID da conta de permissão no formato iam:domain::domain_id. domain_id indica o ID da conta do usuário autorizado, por exemplo, iam:domain::6e9dfd51d1124e8d8498dce894923a0d. Pesquisa difusa é suportada. Mínimo: 1 Máximo: 1000 |
| limit | Não | Integer | Especifica o número de registros de lista branca retornados do serviço do ponto de extremidade da VPC em cada página. O valor varia de 0 a 500 e é geralmente 10, 20 ou 50. O número padrão é 10. Mínimo: 1 Máximo: 500 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 |
| sort_key | Não | String | Especifica o campo de classificação dos registros da lista branca. O valor é do ponto de extremidade, indicando a hora em que o registro da lista branca é adicionado. Padrão: create_at |
| sort_dir | Não | String | Especifica o método de classificação dos registros da lista branca, que pode ser: ● desc: os registros da lista branca são classificados em ordem decrescente. ● asc: os registros da lista branca 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 |
|---|---|---|
| permissions | Array of PermissionObject objects | Lista os registros da lista branca. |
| total_count | Integer | Especifica o número total de registros da lista branca 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 da permissão. |
| Permissão | String | Especifica permissões. O formato de permissões é iam:domain::6e9dfd51d1124e8d8498dce894923a0d ou *.
|
| created_at | String | Especifica a hora de adicionar o registro de lista branca. O formato de hora UTC aplicado é AAAA-MMDDTHH:MM:SSZ. |
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 |
| Código | 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/4189d3c2-8882-4871-a3c2-d380272eed88/permissions?permission={permission}&sort_dir={sort_dir}&limit={limit}&offset={offset} This request is to query whitelist records 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/permissions Exemplo de respostas
Código de estado: 200
O servidor processou a solicitação com sucesso.
{ "permissions" : [ { "id" : "f2659906-c622-480a-83e9-ef42bdb67b90", "permission" : "*", "created_at" : "2018-10-18T13:26:40Z" } ], "total_count" : 1 } 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.