获取所有域名及证书信息--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取所有域名及证书信息

最近更新时间：2024.01.31 15:10:05首次发布时间：2022.11.09 10:16:21

本接口支持获取所有域名以及证书信息。

使用说明

接口名称：GetImageAllDomainCert
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/Action=GetImageAllDomainCert&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：15 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

返回参数

参数	类型	描述
domain	String	域名
domain_status	String	域名状态
cert_id	String	证书 ID
cert_name	String	证书名
cert_common_name	String	证书通用名
cert_not_after	Integer	证书过期时间，单位为秒。
san	Array of String	适配的域名列表（Subject Alternative Names）

示例

请求示例

GET https://imagex.volcengineapi.com/Action=GetImageAllDomainCert&Version=2018-08-01

正常返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30"
        "Action":"GetImageAllDomainCert",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
    },
    "Result":[
        {
            "domain": "test.volcimagextest.com",
            "domain_status": "正常",
            "cert_id": "61b442f5659b4e13a07ae56330d0f939",
            "cert_name": "证书域名: *.volcimagextest.com",
            "cert_common_name": "*.volcimagextest.com",
            "cert_not_after": 1680537599,
            "san": ["*.volcimagextest.com", "volcimagextest.com"]
        }
    ]
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action":"GetImageAllDomainCert",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问公共错误码和通用错误码获取详细信息。