Consulta de detalhes do certificado vinculado a um nome de domínio
Função
Esta API é usada para consultar os detalhes do certificado vinculado a um nome de domínio.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| project_id | Sim | String | ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento. |
| instance_id | Sim | String | ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG. |
| group_id | Sim | String | ID do grupo da API. |
| domain_id | Sim | String | ID do domínio. |
| certificate_id | Sim | String | ID do certificado. |
Parâmetros de solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| X-Auth-Token | Sim | String | Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. |
Parâmetros de resposta
Código de status: 200
| Parâmetro | Tipo | Descrição |
|---|---|---|
| common_name | String | Nome de domínio do certificado. |
| san | Array of strings | Nomes alternativos do assunto. |
| version | Integer | Versão do certificado. |
| organization | Array of strings | Empresa ou organização. |
| organizational_unit | Array of strings | Departamento. |
| locality | Array of strings | Cidade. |
| state | Array of strings | Estado ou província. |
| country | Array of strings | País ou região. |
| not_before | String | Hora de início do período de validade do certificado. |
| not_after | String | Hora de término do período de validade do certificado. |
| serial_number | String | Número de série. |
| issuer | Array of strings | Emissor do certificado. |
| signature_algorithm | String | Algoritmo de assinatura. |
Código de status: 400
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 401
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 403
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 404
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Código de status: 500
| Parâmetro | Tipo | Descrição |
|---|---|---|
| error_code | String | Código de erro. |
| error_msg | String | Mensagem de erro. |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 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 status: 400
Solicitação inválida
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:domain_id. Please refer to the support documentation"
} Código de status: 401
Não autorizado
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de status: 403
Proibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de status: 404
Não encontrado
{
"error_code" : "APIG.3020",
"error_msg" : "The URL domain does not exist"
} Código de status: 500
Erro do servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
| 400 | Solicitação inválida |
| 401 | Não autorizado |
| 403 | Proibido |
| 404 | Não encontrado |
| 500 | Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.