Consulta das dependências
Função
Essa API é usada para consultar todas as dependências.
URI
GET /v2/{project_id}/fgs/dependencies
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
project_id |
Sim |
String |
ID do projeto. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
marker |
Não |
String |
Registro final consultado da última vez. Valor padrão: 0. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
maxitems |
Não |
String |
Número máximo de itens a serem devolvidos em uma solicitação. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
ispublic |
Não |
String |
Se uma dependência é pública. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
dependency_type |
Não |
String |
Tipo de dependência. Opções: públicas, privadas e todas. Valor padrão: all. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
runtime |
Não |
String |
Ambiente para execução de uma função. Opções:
|
|
name |
Não |
String |
Nome da dependência. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
limit |
Não |
String |
Número máximo de dependências que podem ser obtidas em uma consulta. Valor padrão: 400. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
Parâmetros de solicitação
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
X-Auth-Token |
Sim |
String |
Token do usuário. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
Parâmetros de resposta
Código de estado: 200
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
dependencies |
Array of ListDependenciesResult objects |
Lista de dependências. |
|
next_marker |
Long |
Próxima leitura localização. |
|
count |
Long |
Número total de dependências. |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
id |
String |
ID da Dependência. |
|
owner |
String |
Proprietário da dependência. público indica uma dependência pública. |
|
link |
String |
URL da dependência no console do OBS. |
|
runtime |
String |
Ambiente para execução de uma função. Opções:
Valores de enumeração:
|
|
etag |
String |
ID da dependência. |
|
size |
Long |
Tamanho da dependência. |
|
name |
String |
Nome da dependência. |
|
file_name |
String |
Nome do arquivo de dependência. |
|
description |
String |
Descrição da dependência. |
|
version |
Long |
Versão de dependência. |
|
last_modified |
Long |
Hora em que a dependência foi atualizada pela última vez. |
Código de estado: 401
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
error_msg |
String |
Mensagem de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
Código de estado: 403
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
error_msg |
String |
Mensagem de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
Código de estado: 404
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
error_msg |
String |
Mensagem de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
Código de estado: 500
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
error_code |
String |
Código de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
|
error_msg |
String |
Mensagem de erro. Mínimo: 0 Máximo: 0 Mínimo: 0 Máximo: 0 |
Exemplos de solicitações
Dependências do inquilino atual.
GET https://{Endpoint}/v2/{project_id}/fgs/ListDependencies?marker=0&maxitems=400
Exemplo de respostas
Código de estado: 200
ok
{ "dependencies" : [ { "id" : "6578de50-9a18-48fa-b84e-b2d36636e433", "owner" : "public", "link" : "https://{obs_endpoint}/functionstage-examples/fg_test_pandas_1.1.3.zip", "runtime" : "Python3.6", "etag" : "35a893d9495b3e22259b2773996bc94d-6", "size" : 31009808, "name" : "panda1.1.3" } ], "next_marker" : 43, "count" : 43 }
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
ok |
|
401 |
Não autorizado. |
|
403 |
Proibido. |
|
404 |
Não encontrado. |
|
500 |
Erro de servidor interno. |
Códigos de erro
Consulte Códigos de erro.