查询HTTPS证书信息 - ShowCertificateInfo
功能介绍
根据项目ID、域名等信息查询HTTPS证书信息
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
live:domain:getCertificates
Read
-
-
-
-
URI
GET /v2/{project_id}/certificates
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 项目ID,获取方法请参考获取项目ID。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
play_domain | 否 | String | 参数解释: 直播播放域名 约束限制: 不涉及 取值范围: 字符长度为[1-255]位 默认取值: 不涉及 |
offset | 否 | Integer | 参数解释: 偏移量,表示从此偏移量开始查询 约束限制: 不涉及 取值范围: 0~2147483647 默认取值: 0 |
limit | 否 | Integer | 参数解释: 每页记录数 约束限制: 不涉及 取值范围: 1~100 默认取值: 10 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
Authorization | 否 | String | 使用AK/SK方式认证时必填,携带的鉴权信息。 |
X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必填,请求的发生时间。 |
X-Project-Id | 否 | String | 使用AK/SK方式认证时必填,携带项目ID信息。 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
total | Number | 参数解释: 总条目数 取值范围: 0~128 |
certificates_info | Array of CertInfoResp objects | 参数解释: 证书信息列表 |
参数 | 参数类型 | 描述 |
|---|---|---|
play_domain | String | 参数解释: 直播播放域名 取值范围: 字符长度为[1-255]位 |
project_id | String | 参数解释: 租户ID 取值范围: 字符长度为[1-64]位 |
tenant_name | String | 参数解释: 租户名称 取值范围: 字符长度为[1-128]位 |
start_time | String | 参数解释: 证书开始时间 取值范围: 格式:YYYY-MM-DDTHH:mm:ssZ,UTC时间 |
expire_time | String | 参数解释: 证书过期时间 取值范围: 格式:YYYY-MM-DDTHH:mm:ssZ,UTC时间 |
cert_type | Integer | 参数解释: 证书类型 取值范围: |
gm_cert_type | Integer | 参数解释: 国密证书类型 取值范围: |
source | String | 参数解释: 证书来源 取值范围: |
cert_name | String | 参数解释: scm来源的证书名, 自有证书为空 取值范围: 字符长度为[0,64]位 |
cert_id | String | 参数解释: scm来源的证书ID, 自有证书为空 取值范围: 字符长度为[0,64]位 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
GET https://{endpoint}/v2/70b76xxxxxx34253880af501cdxxxxxx/certificates?play_domian=play.example.huawei.com 响应示例
状态码:200
查询HTTPS证书信息成功
{
"total" : 2,
"certificates_info" : [ {
"play_domain" : "play.example.huawei.com",
"project_id" : "70b76xxxxxx34253880af501cdxxxxxx",
"tenant_name" : "huaweiTest",
"start_time" : "2021-03-03T01:34:01Z",
"expire_time" : "2022-04-04T01:34:01Z"
}, {
"play_domain" : "play.example.hwcloud.com",
"project_id" : "70b76xxxxxx34253880af505cdxxxxxx",
"tenant_name" : "huaweiTest001",
"start_time" : "2021-02-03T01:34:01Z",
"expire_time" : "2022-05-04T01:34:01Z"
} ]
} 状态码:400
参数错误
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal",
"request_id" : "xxxx-xxxx-xxxx-xxxx"
} 状态码
状态码 | 描述 |
|---|---|
200 | 查询HTTPS证书信息成功 |
400 | 参数错误 |
错误码
请参见错误码。

