You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /
  • 应用型负载均衡

DescribeCertificates

最近更新时间：2024.02.29 14:48:18

首次发布时间：2022.05.20 22:35:13

我的收藏

API 说明

API 名称：DescribeCertificates。
API 域名：open.volcengineapi.com。
API 描述：查询证书列表，单个账号每次最多查询100个证书。

使用限制

节流限制：每秒最多提交 40 个 API 请求。

快速调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称，如 DescribeCertificates 。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint否900表示签名的有效时间，单位是秒，默认值是900。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例值
CertificateIds.N
List of String
否

证书的ID，N代表证书的序号。

  • - N：表示证书的序号，取值范围为1 ～ 100。
  • 多个证书间使用“&”分隔。
CertificateIds.1=cert-123*** 765&CertificateIds.2=cert-234****876
CertificateNameString否证书的名称。test
PageSizeInteger否分页查询时每页的行数，取值1-100，默认为10。20
PageNumberInteger否列表的页码，默认值为1。1
ProjectNameString否证书所属项目名称。default

响应正文

参数类型参数说明示例值
RequestId
String
请求ID。
20210816110638****2514606306AF947C
PageSizeInteger当前分页的行数。20
PageNumberInteger当前页码。1
TotalCountInteger符合条件的证书总数。50
CertificatesArray符合条件的证书的详细信息，具体请参见 Certificates 。-

Certificates

参数类型参数说明示例值
CertificateId
String
证书ID。
cert-123***765
CertificateNameString证书名称。test
CertificateTypeString证书类型，1. 服务器证书（Server）。server
DescriptionString证书描述。test
CreateTimeString证书的创建时间。2021-12-14T11:13:40+08:00
ExpiredAtString证书的过期时间。2021-12-14T11:13:40+08:00
DomainNameString证书的域名。test.com
ListenersList of String证书关联的监听器列表。[lsn-123 *****112,lsn-234 *****567]

Status

String

证书的状态，取值为：

  • Creating：创建中。
  • Active：运行中。
  • Deleting：删除中。

Active

ProjectNameString证书所属项目名称。default

示例

请求示例

GET /?Action=DescribeCertificates&CertificateIds.1=cert-2fe5jqh****hs5oxruwk7x9ze&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20210816110638****2514606306AF947C",
        "Action": "DescribeCertificates",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210816110638****2514606306AF947C",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Certificates": [
            {
                "CertificateId": "cert-2fe5k****c16o5oxruvtk3qf5",
                "CertificateName": "test",
                "CertificateType": "server",
                "Description": "test",
                "CreateTime": "2021-12-14T11:13:40+08:00",
                "ExpiredAt": "2021-12-14T11:13:40+08:00",
                "DomainName": "*.a.cdn-build.net",
                "Listeners": [
                    "lsn-1g0e0p14****88ibuxxpnwden",
                    "lsn-1g0e0p90e****8ibuxwy36kc1"
                ]
            }
        ]
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code错误码错误信息错误描述
400LimitExceed.ServerCertificateYou've reached the limit on the number of server certificates that you can operate at a time.已达到单次可操作的服务器证书的数量上限。
400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
400InvalidCertificateName.MalformedThe specified CertificateName is malformed.指定的 CertificateName 参数格式不合法。