Creación de un certificado SSL
Función
Esta API se utiliza para crear un certificado SSL.
Método de invocación
Para obtener más información, véase invocación de API.
URI
POST /v2/{project_id}/apigw/certificates
|
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. |
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 |
|---|---|---|---|
|
name |
Sí |
String |
Nombre del certificado. Puede contener de 4 a 50 caracteres, empezando por una letra. Solo se permiten letras, dígitos y guiones bajos (_). |
|
cert_content |
Sí |
String |
Contenido del certificado. |
|
private_key |
Sí |
String |
Certificación de clave privada. |
|
type |
No |
String |
Alcance del certificado. Predeterminado: global |
|
instance_id |
No |
String |
ID de gateway. Este parámetro es necesario si type se establece en instancia. |
|
trusted_root_ca |
No |
String |
Certificado raíz (CA) de confianza. |
|
algorithm_type |
No |
String |
Tipo de algoritmo de certificado:
|
|
cert_content_sign |
No |
String |
Contenido del certificado de firma. Este parámetro es obligatorio solo cuando el parámetro algoritmo_type se establece en SM2. Máximo: 8092 |
|
private_key_sign |
No |
String |
Contenido de clave privada de firma. Este parámetro es obligatorio solo cuando el parámetro algoritmo_type se establece en SM2. Máximo: 8092 |
Parámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
id |
String |
ID del certificado. |
|
name |
String |
Nombre del certificado. |
|
type |
String |
Tipo de certificado.
|
|
instance_id |
String |
ID de gateway.
|
|
project_id |
String |
ID del proyecto. |
|
common_name |
String |
Nombre de dominio. |
|
san |
Array of strings |
Nombre de dominio de SAN. |
|
not_after |
String |
Tiempo de caducidad. |
|
signature_algorithm |
String |
Algoritmo de firma. |
|
create_time |
String |
Tiempo de creación. |
|
update_time |
String |
Tiempo de actualización. |
|
is_has_trusted_root_ca |
Boolean |
Si existe un certificado raíz (CA) de confianza. El valor es true si existe trusted_root_ca en el certificado asociado. Predeterminado: false |
|
algorithm_type |
String |
Tipo de algoritmo de certificado:
|
|
version |
Integer |
Versión. |
|
organization |
Array of strings |
Empresa u organización. |
|
organizational_unit |
Array of strings |
Departamento. |
|
locality |
Array of strings |
Ciudad. |
|
state |
Array of strings |
Estado o provincia. |
|
country |
Array of strings |
País o región. |
|
not_before |
String |
Tiempo efectivo. |
|
serial_number |
String |
Número de serie. |
|
issuer |
Array of strings |
Emisor. |
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
Creación de un certificado SSL
{
"name" : "cert_demo",
"private_key" : "'-----BEGIN PRIVATE KEY-----THIS IS YOUR PRIVATE KEY-----END PRIVATE KEY-----\\n'",
"cert_content" : "'-----BEGIN CERTIFICATE-----THIS IS YOUR CERT CONTENT-----END CERTIFICATE-----\\n'",
"type" : "instance",
"instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e"
}
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"id" : "a27be832f2e9441c8127fe48e3b5ac67",
"name" : "cert_demo",
"common_name" : "apigtest.example.com",
"san" : [ "apigtest.example.com", "*.san.com" ],
"version" : 3,
"organization" : [ "XX" ],
"organizational_unit" : [ "IT" ],
"locality" : [ "XX" ],
"state" : [ "XX" ],
"country" : [ "XX" ],
"not_before" : "2019-06-01T00:00:00Z",
"not_after" : "2031-08-16T06:36:13Z",
"serial_number" : "13010",
"issuer" : [ "XXSSL Inc" ],
"signature_algorithm" : "SHA256-RSA",
"create_time" : "2021-08-20T02:03:53Z",
"update_time" : "2021-08-20T02:03:53Z",
"algorithm_type" : "RSA"
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.3325",
"error_msg" : "The API quota name already exists"
}
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.3030",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
}
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 |
|---|---|
|
200 |
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.