查询证书列表
功能介绍
查询证书列表
URI
GET /v1/{project_id}/waf/certificate
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,对应控制台用户名->我的凭证->项目列表->项目ID |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enterprise_project_id |
否 |
String |
您可以通过调用企业项目管理服务(EPS)的查询企业项目列表接口(ListEnterpriseProject)查询企业项目id |
page |
否 |
Integer |
分页查询时,返回第几页数据。默认值为1,表示返回第1页数据。 缺省值:1 |
pagesize |
否 |
Integer |
分页查询时,每页包含多少条结果。范围1-100,默认值为10,表示每页包含10条结果。 缺省值:10 |
name |
否 |
String |
证书名称 |
host |
否 |
Boolean |
是否获取证书关联的域名,默认为false -true:获取已关联域名的证书 -false:获取未关联域名的证书 缺省值:false |
exp_status |
否 |
Integer |
证书过期状态,0-未过期,1-已过期,2-即将过期(证书将在一个月内过期) |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Content-Type |
是 |
String |
内容类型 缺省值:application/json;charset=utf8 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
items |
Array of CertificateBody objects |
证书列表 |
total |
Integer |
证书总数 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
证书id |
name |
String |
证书名 |
expire_time |
Long |
证书过期时间戳 |
exp_status |
Integer |
证书过期状态,0-未过期,1-已过期,2-即将过期(一个月内即将过期) |
timestamp |
Long |
证书上传时间戳 |
bind_host |
Array of BindHost objects |
证书关联的域名信息 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
域名ID |
hostname |
String |
域名 |
waf_type |
String |
域名对应模式:cloud(云模式)/premium(独享模式) |
mode |
String |
仅独享模式涉及特殊域名模式 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误信息 |
请求示例
GET https://{Endpoint}/v1/{project_id}/waf/certificate?enterprise_project_id=0
响应示例
状态码: 200
OK
{ "total" : 1, "items" : [ { "id" : "dc443ca4f29c4f7e8d4adaf485be317b", "name" : "demo", "timestamp" : 1643181401751, "expire_time" : 1650794100000, "bind_host" : [ ], "exp_status" : 2 } ] }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
请求失败 |
401 |
token权限不足 |
500 |
服务器内部错误 |
错误码
请参见错误码。