Criação de uma dependência
Função
Esta API é usada para criar uma dependência.
URI
POST /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â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âmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
depend_file | Não | String | Este parâmetro é obrigatório quando depend_type é definido como zip. Ele está no formato de fluxo de arquivo e deve ser um arquivo ZIP codificado usando Base64. |
depend_link | Não | String | URL da dependência no console do OBS quando depend_type é definido como obs. |
depend_type | Sim | String | Modo de importação. Opções: obs e zip. |
runtime | Sim | String | Tempo de execução. Java 11, Node.js 14 e Python 3 são suportados quando o tipo é definido como v2. Valores de enumeração:
|
name | Sim | String | Nome da dependência. Pode conter um máximo de 96 caracteres e deve começar com uma letra e terminar com uma letra ou dígito. Somente letras, dígitos, sublinhados (_), pontos (.), e hífens (-) são permitidos. |
description | Não | String | Descrição da dependência, que pode conter no máximo 512 caracteres. |
Parâmetros de resposta
Código de estado: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
id | String | ID da dependência. |
owner | String | Proprietário da dependência. |
link | String | URL da dependência no console do OBS. |
runtime | String | Tempo de execução. |
etag | String | ID da dependência. |
size | Long | Tamanho da dependência. |
name | String | Nome da dependência. |
description | String | Descrição da dependência. |
file_name | String | Nome do arquivo de 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: 400
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: 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 |
Código de estado: 503
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
- Criar uma dependência carregando diretamente um arquivo ZIP.
POST https://{Endpoint}/v2/{project_id}/fgs/dependencies { "depend_file" : "xxx", "depend_type" : "zip", "runtime" : "Node.js8.10", "name" : "xxx" } - Criar uma dependência carregando um arquivo ZIP do OBS.
POST https://{Endpoint}/v2/{project_id}/fgs/dependencies { "depend_link" : "https://{bucket}.{obs_endpoint}/depends/****/4f4ae4eb-dcdc-4dd3-bffd-79600bd972b3.zip", "depend_type" : "obs", "runtime" : "Node.js8.10", "name" : "xxx" }
Exemplo de respostas
Código de estado: 200
ok
{ "id" : "4f4ae4eb-dcdc-4dd3-bffd-79600bd972b3", "owner" : "*****", "link" : "https://{bucket}.{obs_endpoint}/depends/****/4f4ae4eb-dcdc-4dd3-bffd-79600bd972b3.zip", "runtime" : "Python3.6", "etag" : "83863be4b6c3a86aef995dbc83aae68f", "size" : 577118, "name" : "python-kafka", "description" : "Python library for Kafka operations.", "file_name" : "python-kafka.zip" } Códigos de status
Código de status | Descrição |
|---|---|
200 | ok |
400 | Solicitação inválida. |
401 | Não autorizado. |
403 | Proibido. |
404 | Não encontrado. |
500 | Erro de servidor interno. |
503 | Serviço indisponível. |
Códigos de erro
Consulte Códigos de erro.
