Crear una nueva fuente de hooks
POST /accounts/{account_id}/core/v1/hookSources
Indica los valores deseados para el recurso Hook Source API que se va a crear.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
Cuerpo de la solicitud
Indica los valores deseados para el recurso Hook Source API que se va a crear.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
nombre |
cadena |
Verdadero |
Cadena JSON que contiene un nombre especificado por el usuario para el recurso. Los valores definidos son:
|
sourceType |
cadena |
Verdadero |
Cadena JSON que define el tipo de fuente del gancho. Los valores definidos son:
|
fuente |
cadena |
Verdadero |
Cadena JSON que contiene el script a ejecutar en formato base64. Los valores definidos son:
|
descripción |
cadena |
Falso |
Cadena JSON que contiene una descripción especificada por el usuario de la fuente del hook. Los valores definidos son:
|
metadatos |
Falso |
Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:
|
Ejemplo de solicitud
{
"type": "application/astra-hookSource",
"version": "1.0",
"name": "Payroll script",
"sourceType": "script",
"source": "ZWNobyAiVkhKaGJuTWdVbWxuYUhSeklRPT0iIHwgYmFzZTY0IC1k",
"description": "Pre and post hook script for payroll"
}
Respuesta
Status: 201, Returns the newly created hookSource resource in the JSON response body.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Verdadero |
Identificador único global del recurso. Los valores definidos son:
|
nombre |
cadena |
Verdadero |
Cadena JSON que contiene un nombre especificado por el usuario para el recurso. Los valores definidos son:
|
privado |
cadena |
Verdadero |
Cadena JSON que indica si el campo de origen se expondrá en las API o se dejará en blanco intencionadamente. Los valores definidos son:
|
precargado |
cadena |
Verdadero |
Cadena JSON que indica si la fuente fue precargada. Los valores definidos son:
|
sourceType |
cadena |
Verdadero |
Cadena JSON que define el tipo de fuente del gancho. Los valores definidos son:
|
fuente |
cadena |
Falso |
Cadena JSON que contiene el script a ejecutar en formato base64. Los valores definidos son:
|
sourceMD5Checksum |
cadena |
Verdadero |
Cadena JSON que contiene la suma de comprobación MD5 calculada para el valor de la clave "source". Los valores definidos son:
|
descripción |
cadena |
Falso |
Cadena JSON que contiene una descripción especificada por el usuario de la fuente del hook. Los valores definidos son:
|
metadatos |
Verdadero |
Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:
|
Ejemplo de respuesta
{
"type": "application/astra-hookSource",
"version": "1.0",
"id": "fae6dfbb-ecb8-58ff-a116-6357eb7c956a",
"name": "Payroll script",
"private": "false",
"preloaded": "false",
"sourceType": "script",
"source": "ZWNobyAiVkhKaGJuTWdVbWxuYUhSeklRPT0iIHwgYmFzZTY0IC1k",
"sourceMD5Checksum": "b1a4b8b0144c3f6be553b626130ca145",
"description": "Pre and post hook script for payroll",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Respuesta
Status: 401, Unauthorized
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Respuesta
Status: 400, Bad request
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos del cuerpo de la solicitud no válidos |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Respuesta
Status: 409, Conflict
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos del cuerpo de la solicitud no válidos |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
Respuesta
Status: 403, Forbidden
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Error
Status: 404, Not found
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta de error
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
etiqueta_tipo_astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
|
valor |
cadena |
Verdadero |
type_astra_metadatos_update
Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:
-
Conforme al esquema de metadatos de Astra. Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
etiquetas |
array["etiqueta_tipo_astra"] |
Falso |
|
CreationTimestamp |
cadena |
Falso |
|
Modificación.Marca de hora |
cadena |
Falso |
|
CreatedBy |
cadena |
Falso |
|
modifiedBy |
cadena |
Falso |
invalidParams
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del parámetro de consulta no válido |
motivo |
cadena |
Verdadero |
Razón por la que el parámetro de consulta no es válido |
invalidFields
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del campo no válido del cuerpo de la solicitud |
motivo |
cadena |
Verdadero |
Motivo por el que el campo del cuerpo de la solicitud no es válido |