Help Center> ROMA Connect> API Reference> Service Integration APIs> SSL Certificate Management> Viewing Certificate Details
Updated on 2023-06-29 GMT+08:00
View PDF

Viewing Certificate Details

Function

View certificate details.

URI

GET /v2/{project_id}/apic/certificates/{certificate_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

certificate_id

Yes

String

Certificate ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Certificate ID.

name

String

Certificate name.

type

String

Certificate type. Options:

  • global: all certificates

  • instance: certificates of the current instance

instance_id

String

Instance ID.

  • type set to global: The default value is common.

  • type set to instance: The default value is the instance ID.

project_id

String

Project ID.

common_name

String

Domain name.

san

Array of strings

SAN.

not_after

String

Validity period end time.

signature_algorithm

String

Signature algorithm.

create_time

String

Creation time.

update_time

String

Update time.

algorithm_type

String

Certificate algorithm type. Options:

  • RSA

  • ECC

  • SM2

To be supported

is_has_trusted_root_ca

Boolean

Whether a trusted root certificate (CA) exists. The value is true if trusted_root_ca exists in the bound certificate.

Default: false

version

Integer

Version.

organization

Array of strings

Company/Organization.

organizational_unit

Array of strings

Department.

locality

Array of strings

City.

state

Array of strings

State/Province.

country

Array of strings

Country.

not_before

String

Validity period start time.

serial_number

String

Serial number.

issuer

Array of strings

Issuer.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "id" : "a27be832f2e9441c8127fe48e3b5ac67",
  "name" : "cert_demo",
  "common_name" : "apigtest.xxx.com",
  "san" : [ "apigtest.xxx.com", "*.san.com" ],
  "version" : 3,
  "organization" : [ "company" ],
  "organizational_unit" : [ "IT" ],
  "locality" : [ "city" ],
  "state" : [ "state" ],
  "country" : [ "Country" ],
  "not_before" : "2019-06-01T00:00:00Z",
  "not_after" : "2031-08-16T06:36:13Z",
  "serial_number" : "13010",
  "issuer" : [ "SSL Inc" ],
  "signature_algorithm" : "SHA256-RSA",
  "create_time" : "2021-08-20T02:03:53Z",
  "update_time" : "2021-08-20T02:03:53Z",
  "algorithm_type" : "RSA"
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:domain_id. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3020",
  "error_msg" : "The URL domain does not exist"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.