Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ SSL Certificate Management/ Obtaining Domain Names Bound to an SSL Certificate
Updated on 2023-06-29 GMT+08:00

Obtaining Domain Names Bound to an SSL Certificate

Function

Obtain domain names bound to an SSL certificate.

URI

GET /v2/{project_id}/apic/certificates/{certificate_id}/attached-domains

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.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

url_domain

No

String

Independent domain name.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

bound_domains

Array of UrlDomainRefInfo objects

Bound domain names.

Table 5 UrlDomainRefInfo

Parameter

Type

Description

url_domain

String

Custom domain name.

id

String

Domain ID.

status

Integer

CNAME resolution status.

  • 1: not parsed

  • 2: parsing

  • 3: parsing succeeded

  • 4: parsing failed

min_ssl_version

String

Minimum SSL version supported.

is_http_redirect_to_https

Boolean

Whether to enable HTTP redirection to HTTPS. The value false means disable and true means enable. The default value is false.

Default: false

verified_client_certificate_enabled

Boolean

Whether to enable client certificate verification. This parameter is available only when a certificate is bound. It is enabled by default if trusted_root_ca exists, and disabled if trusted_root_ca does not exist.

Default: false

ssl_id

String

Certificate ID.

ssl_name

String

Certificate name.

api_group_id

String

API group ID.

api_group_name

String

API group name.

instance_id

String

Instance ID.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 9 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

{
  "total" : 1,
  "size" : 1,
  "bound_domains" : [ {
    "id" : "b9be707660c5406394f8973e087bae20",
    "url_domain" : "apigtest.xxx.com",
    "status" : 3,
    "min_ssl_version" : "TLSv1.1",
    "ssl_id" : "a27be832f2e9441c8127fe48e3b5ac67",
    "ssl_name" : "cert_demo",
    "instance_id" : "f0fa1789-3b76-433b-a787-9892951c620e",
    "api_group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "api_group_name" : "default"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:dict_name. 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: 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

500

Internal Server Error

Error Codes

See Error Codes.