Modificar una cuenta
PUT /accounts/{account_id}
Sustituye todo el recurso almacenado por el cuerpo de la solicitud JSON suministrado mientras conserva los valores clave que no son modificables por el usuario.
Efectos secundarios
-
Cambiar "isEnabled" de "false" a "true" establece "enabledTimestamp" en la hora actual.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID de la colección de cuentas a listar
|
Cuerpo de la solicitud
Sustituye todo el recurso almacenado por el cuerpo de la solicitud JSON suministrado mientras conserva los valores clave que no son modificables por el usuario.
Efectos secundarios
-
Cambiar "isEnabled" de "false" a "true" establece "enabledTimestamp" en la hora actual.
| 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 |
Falso |
Identificador único global del recurso. Los valores definidos son:
|
nombre |
cadena |
Falso |
Cadena JSON que contiene un nombre para la cuenta. Los valores definidos son:
|
estado |
cadena |
Falso |
Cadena JSON que contiene un valor que indica el estado operativo de la cuenta. Los valores definidos son:
|
isEnabled |
cadena |
Falso |
Cadena JSON que indica que la cuenta está habilitada. Los valores definidos son:
|
enabledTimestamp |
cadena |
Falso |
Cadena JSON que contiene la marca de tiempo que indica cuándo se habilitó la cuenta por última vez. Si la cuenta nunca se ha habilitado, este campo está ausente. Los valores definidos son:
|
accountContact |
Falso |
Objeto JSON que contiene información de contacto del usuario para crear un usuario propietario en el momento de la activación de la cuenta. |
|
metadatos |
Falso |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de solicitud
{
"type": "application/astra-account",
"version": "1.0",
"name": "frightened-pine"
}
Respuesta
Status: 204, Indicates if the account resource was updated.
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 no válidos en el cuerpo de la solicitud |
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 no válidos en el cuerpo de la solicitud |
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/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
postalAddress
Objeto JSON que contiene una colección de cadenas JSON que especifican una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si existe esta clave, estarán presentes las seis cadenas JSON contenidas. Si no proporcionas nada, la cadena estará vacía.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
addressCountry |
cadena |
Falso |
Cadena JSON que contiene el nombre del país o el código de país asociado a la dirección postal, tal como se especifica en ISO 3166 Alfa-2. Los valores definidos son:
|
addressLocality |
cadena |
Falso |
Cadena JSON que contiene la localidad (por ejemplo, ciudad) asociada a la dirección postal. Los valores definidos son:
|
addressRegion |
cadena |
Falso |
Cadena JSON que contiene la región (por ejemplo, estado) asociada a la dirección postal. Los valores definidos son:
|
postalCode |
cadena |
Falso |
Cadena JSON que contiene el código postal asociado a la dirección postal. Los valores definidos son:
|
streetAddress1 |
cadena |
Falso |
Cadena JSON que contiene la dirección de la calle asociada a la dirección postal. Los valores definidos son:
|
streetAddress2 |
cadena |
Falso |
Cadena JSON que contiene información auxiliar opcional sobre la dirección, el apartado de correos y más. Los valores definidos son:
|
accountContact
Objeto JSON que contiene información de contacto del usuario para crear un usuario propietario en el momento de la activación de la cuenta.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
firstName |
cadena |
Falso |
Cadena JSON que contiene un nombre largo especificado por el usuario. Los valores definidos son:
|
lastName |
cadena |
Falso |
Cadena JSON que contiene un apellido largo especificado por el usuario. Los valores definidos son:
|
companyName |
cadena |
Falso |
Cadena JSON que contiene el nombre de la empresa asociada al usuario. Si esta clave no existe, indica que no se ha proporcionado un nombre de empresa. Los valores definidos son:
|
correo electrónico |
cadena |
Falso |
Cadenas JSON que contienen una dirección de correo electrónico especificada por el usuario. Los valores definidos son:
|
teléfono |
cadena |
Falso |
Cadena JSON que contiene el número de teléfono del usuario. Si esta clave no existe, indica que no se ha proporcionado un número de teléfono. Los valores definidos son:
|
postalAddress |
Falso |
Objeto JSON que contiene una colección de cadenas JSON que especifican una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si existe esta clave, estarán presentes las seis cadenas JSON contenidas. Si no proporcionas nada, la cadena estará vacía. |
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 al recurso. Los valores definidos son:
-
Se ajusta 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 |