Help Center> ROMA Connect> API Reference> APIC APIs> Domain Name Management> Querying Details of the Certificate Bound to a Domain Name
View PDF

Querying Details of the Certificate Bound to a Domain Name

Function

This API is used to query the details of the certificate bound to a domain name.

URI

GET /v2/{project_id}/apic/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{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.

instance_id

Yes

String

Instance ID.

group_id

Yes

String

API group ID.

domain_id

Yes

String

Domain ID.

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

common_name

String

Request throttling policy list.

san

Array of strings

SAN domain name.

version

String

Certificate version.

organization

Array of strings

Company and organization.

organizational_unit

Array of strings

Department.

locality

Array of strings

City.

state

Array of strings

Province.

country

Array of strings

Country.

not_before

String

Start time of the certificate validity period.

not_after

String

End time of the certificate validity period.

serial_number

String

Serial number.

issuer

Array of strings

Issuer.

signature_algorithm

String

Signature algorithm.

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

{
  "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" : [ "Country\\\\DESKTOP-L2TFOFH" ]
}

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.

Parent topic: Domain Name Management