Vinculación de un certificado SSL a un nombre de dominio
Función
Esta API se utiliza para vincular un certificado SSL a un nombre de dominio. Para los gateway con puertos de entrada personalizados, el mismo nombre de dominio se vincula a un certificado al mismo tiempo. La habilitación o deshabilitación de la verificación del cliente tiene efecto para diferentes puertos del mismo nombre de dominio.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/certificates/{certificate_id}/domains/attach
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| project_id | Sí | String | ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto. |
| certificate_id | Sí | String | ID del certificado. |
Parámetros de solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| X-Auth-Token | Sí | String | Token de usuario. Se puede obtener invocando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| domains | Sí | Array of AttachOrDetachDomainInfo objects | Nombres de dominio a los que el certificado está vinculado o no vinculado. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| domain | Sí | String | Nombre de dominio. |
| instance_ids | No | Array of strings | Los ID de gateway. |
| verified_client_certificate_enabled | No | Boolean | Si se debe habilitar la verificación de certificados de cliente. Se habilita por defecto si trusted_root_ca existe, y se deshabilita si trusted_root_ca no existe. |
Parámetros de respuesta
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 401
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 403
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 404
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 500
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Ejemplo de las solicitudes
Vinculación de un certificado SSL a un nombre de dominio
{
"domains" : [ {
"domain" : "apigtest.example.com",
"instance_ids" : [ "f0fa1789-3b76-433b-a787-9892951c620e", "7d39549681c54d968ec2910da9da95cd" ]
} ]
} Ejemplo de respuestas
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:domain_id. Please refer to the support documentation"
} Código de estado: 401
Sin autorización
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de estado: 403
Prohibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de estado: 404
No se ha encontrado
{
"error_code" : "APIG.3020",
"error_msg" : "The URL domain does not exist"
} Código de estado: 500
Error del servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 204 | Aceptar |
| 400 | Error en la solicitud |
| 401 | Sin autorización |
| 403 | Prohibido |
| 404 | No se ha encontrado |
| 500 | Error del servidor interno |
Códigos de error
Consulte Códigos de error.
