Modificar un certificado
PUT /accounts/{account_id}/core/v1/certificates/{certificate_id}
Sustituye todo el recurso almacenado por el cuerpo de la solicitud JSON suministrado.
Efectos secundarios
-
Se actualizará un certificado CA actualizado en el almacén de confianza.
-
Si un certificado de CA de confianza existente deja de ser de confianza, se eliminará del almacén de confianza.
-
Si se actualiza una entidad de certificación (campo "cert"), debe incluirse el indicador "isSelfSigned" para indicar el estado del nuevo certificado. Si no se incluye el indicador "isSelfSigned" en este caso, el valor se establecerá en "false".
-
Si una actualización no modifica el cuerpo del certificado (campo "cert"), el indicador "isSelfSigned" es opcional y se conservará el valor existente si no se proporciona.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
id_certificado |
cadena |
ruta |
Verdadero |
ID de la colección de certificados a listar |
Cuerpo de la solicitud
Sustituye todo el recurso almacenado por el cuerpo de la solicitud JSON suministrado.
Efectos secundarios
-
Se actualizará un certificado CA actualizado en el almacén de confianza.
-
Si un certificado de CA de confianza existente deja de ser de confianza, se eliminará del almacén de confianza.
-
Si se actualiza una entidad de certificación (campo "cert"), debe incluirse el indicador "isSelfSigned" para indicar el estado del nuevo certificado. Si no se incluye el indicador "isSelfSigned" en este caso, el valor se establecerá en "false".
-
Si una actualización no modifica el cuerpo del certificado (campo "cert"), el indicador "isSelfSigned" es opcional y se conservará el valor existente si no se proporciona.
| 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:
|
certUse |
cadena |
Falso |
Cadena JSON que indica el uso del certificado. Si no se especifica, por defecto es "rootCA". Los valores definidos son:
|
cert |
cadena |
Falso |
Cadena JSON que contiene un certificado con formato PKCS-11 codificado en base64 (PEM). Los valores definidos son:
|
cn |
cadena |
Falso |
Cadena JSON que contiene un nombre común extraído del certificado. Los valores definidos son:
|
expiryTimestamp |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo que indica cuándo caduca el certificado. Los valores definidos son:
|
isSelfSigned |
cadena |
Falso |
Cadena JSON que indica si el certificado es autofirmado. Si no se proporciona en la creación, el valor predeterminado es "false". En la actualización:
|
trustState |
cadena |
Falso |
Cadena JSON que contiene uno de un conjunto de valores enumerados que indican si el certificado es de confianza. Los valores definidos son:
|
trustStateTransitions |
array["type_astra_stateTransition"] |
Falso |
Matriz JSON de objetos JSON, cada uno de los cuales representa el conjunto de transiciones de estado permitidas desde un estado definido dado. Cada objeto JSON contiene los campos "from" y "to", donde el valor "from" es el nombre de un estado y el valor "to" es una matriz de estados de destino permitidos. |
trustStateDesired |
cadena |
Falso |
Cadena JSON que contiene un valor que indica si el certificado es de confianza. Si no se especifica al crear, el valor predeterminado es "trusted". Los valores definidos son:
|
trustStateDetails |
array["type_astra_stateDetail"] |
Falso |
Matriz JSON de objetos JSON que enumera detalles adicionales sobre el estado de confianza del certificado. Si no hay detalles disponibles, esta matriz estará vacía.
|
metadatos |
Falso |
Metadatos especificados por el cliente y el servicio asociados al recurso. Los valores definidos son:
|
Ejemplo de solicitud
{
"type": "application/astra-certificate",
"version": "1.1",
"trustStateDesired": "trusted"
}
Respuesta
Status: 204, Indicates if the certificate 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"
}
Respuesta
Status: 503, Service unavailable
| 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/41",
"title": "Service not ready",
"detail": "Currently, the service can't respond to this request.",
"status": "503"
}
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
type_astra_stateTransition
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
de |
cadena |
Verdadero |
|
a |
array[string] |
Verdadero |
type_astra_stateDetail
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
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 |