Consulta de certificados SSL
Función
Esta API se utiliza para consultar los certificados SSL.
Método de invocación
Para obtener más información, véase invocación de API.
URI
GET /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ámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
offset |
No |
Long |
Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0 |
|
limit |
No |
Integer |
Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20 |
|
name |
No |
String |
Nombre del certificado. |
|
common_name |
No |
String |
Nombre de dominio del certificado. |
|
signature_algorithm |
No |
String |
Algoritmo de firma de certificado. |
|
type |
No |
String |
Alcance del certificado. |
|
instance_id |
Sí |
String |
ID de gateway a la que pertenece el certificado. |
|
algorithm_type |
No |
String |
Tipo de algoritmo de 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ámetros de respuesta
Código de estado: 200
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
size |
Integer |
Longitud de la lista de recursos devuelta. |
|
total |
Long |
Número de recursos que coinciden con las condiciones de consulta. |
|
certs |
Array of CertBase objects |
Certificado de contenido básico. |
|
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:
|
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: 500
|
Parámetro |
Tipo |
Descripción |
|---|---|---|
|
error_code |
String |
Código de error. |
|
error_msg |
String |
Mensaje de error. |
Ejemplo de las solicitudes
Ninguno
Ejemplo de respuestas
Código de estado: 200
Aceptar
{
"total" : 1,
"size" : 1,
"certs" : [ {
"id" : "a27be832f2e9441c8127fe48e3b5ac67",
"name" : "cert_demo",
"type" : "instance",
"project_id" : "73d69ae0cfcf460190522d06b60f05ad",
"instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
"common_name" : "apigtest.example.com",
"san" : [ "apigtest.example.com", "*.san.com" ],
"not_after" : "2021-04-26T09:03:30Z",
"signature_algorithm" : "SHA256-RSA",
"create_time" : "2021-08-26T07:27:06.304004Z",
"update_time" : "2021-08-26T07:27:06.304004Z",
"algorithm_type" : "RSA"
} ]
}
Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:dict_name. 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: 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 |
|
500 |
Error del servidor interno |
Códigos de error
Consulte Códigos de error.