Consulta de detalles del certificado vinculado a un nombre de dominio
Función
Esta API se utiliza para consultar los detalles del certificado enlazado a un nombre de dominio.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}
|
Parámetro |
Obligatorio |
Tipo |
Descripción |
|---|---|---|---|
|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
|
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
|
group_id |
Sí |
String |
ID de grupo de API. |
|
domain_id |
Sí |
String |
ID de dominio. |
|
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 llamando 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 |
|---|---|---|
|
common_name |
String |
Nombre de dominio del certificado. |
|
san |
Array of strings |
Sujeto nombres alternativos. |
|
version |
Integer |
Versión del certificado. |
|
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 |
Hora de inicio del período de validez del certificado. |
|
not_after |
String |
Hora de finalización del período de validez del certificado. |
|
serial_number |
String |
Número de serie. |
|
issuer |
Array of strings |
Emisor del certificado. |
|
signature_algorithm |
String |
Algoritmo de firma. |
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. |
Solicitudes de ejemplo
Ninguna
Ejemplo de respuestas
Código de estado: 200
OK
{
"serial_number" : "219450666855693268010130472645821723203",
"version" : 3,
"san" : [ "www.company.com" ],
"not_before" : "2019-06-01T00:00:00Z",
"issuer" : [ "mkcert development CA" ],
"not_after" : "2030-08-04T07:41:19Z",
"organization" : [ "mkcert development certificate" ],
"signature_algorithm" : "SHA256-RSA",
"organizational_unit" : [ "XXX\\\\DESKTOP-L2TFOFH" ]
}
Código de estado: 400
Bad Request
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:domain_id. Please refer to the support documentation"
}
Código de estado: 401
Unauthorized
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
}
Código de estado: 403
Forbidden
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
}
Código de estado: 404
Not Found
{
"error_code" : "APIG.3020",
"error_msg" : "The URL domain does not exist"
}
Código de estado: 500
Internal Server Error
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
}
Códigos de estado
|
Código de estado |
Descripción |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
|
403 |
Forbidden |
|
404 |
Not Found |
|
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.
