文档首页> API网关 APIG> API参考> 专享版API（V2）> 专享版-域名管理> 查看域名证书
更新时间：2023-11-30 GMT+08:00
在线调试
CLI示例
查看PDF

查看域名证书

功能介绍

查看域名下绑定的证书详情。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{certificate_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方式请参见获取项目ID。

instance_id

是

String

实例ID，在API网关控制台的“实例信息”中获取。

group_id

是

String

分组的编号

domain_id

是

String

域名的编号

certificate_id

是

String

证书的编号

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

id

String

证书ID

name

String

证书名称

type

String

证书类型

  • global：全局证书

  • instance：实例证书

枚举值：

  • global

  • instance

instance_id

String

实例编码

  • type为global时，缺省为common

  • type为instance时，为实例编码

project_id

String

租户项目编号

create_time

String

创建时间

update_time

String

更新时间

common_name

String

证书域名

san

Array of strings

SAN域名

version

Integer

证书版本

organization

Array of strings

公司、组织

organizational_unit

Array of strings

部门

locality

Array of strings

城市

state

Array of strings

省份

country

Array of strings

国家

not_before

String

证书有效期起始时间

not_after

String

证书有效期截止时间

serial_number

String

序列号

issuer

Array of strings

颁发者

signature_algorithm

String

签名算法

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 403

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 404

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

无

响应示例

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

状态码： 400

Bad Request

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

状态码： 404

Not Found

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

状态码： 500

Internal Server Error

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

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

父主题： 专享版-域名管理