文档首页/ 应用与数据集成平台 ROMA Connect/ API参考/ 服务集成API/ SSL证书管理/ 获取SSL证书已绑定域名列表
更新时间：2023-11-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取SSL证书已绑定域名列表

功能介绍

获取SSL证书已绑定域名列表。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见API参考的“附录 > 获取项目ID”章节。

certificate_id

是

String

证书的编号
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Long

偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0

缺省值：0

limit

否

Integer

每页显示的条目数量

最小值：1

最大值：500

缺省值：20

url_domain

否

String

独立域名

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

size

Integer

本次返回的列表长度

total

Long

满足条件的记录数

bound_domains

Array of UrlDomainRefInfo objects

已绑定域名集合
表5 UrlDomainRefInfo

参数

参数类型

描述

url_domain

String

自定义域名

id

String

自定义域名的编号

status

Integer

CNAME解析状态

  • 1: 未解析

  • 2: 解析中

  • 3: 解析成功

  • 4: 解析失败

min_ssl_version

String

支持的最小SSL版本

is_http_redirect_to_https

Boolean

是否开启http到https的重定向，false为关闭，true为开启，默认为false

缺省值：false

verified_client_certificate_enabled

Boolean

是否开启客户端证书校验。只有绑定证书时，该参数才生效。当绑定证书存在trusted_root_ca时，默认开启；当绑定证书不存在trusted_root_ca时，默认关闭。

缺省值：false

ssl_id

String

证书ID

ssl_name

String

证书名称

api_group_id

String

所属API分组ID

api_group_name

String

所属API分组名称

instance_id

String

所属实例ID

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

状态码： 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"
  } ]
}

状态码： 400

Bad Request

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

状态码： 401

Unauthorized

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

状态码： 403

Forbidden

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

状态码： 500

Internal Server Error

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： SSL证书管理

相关文档