DescribeCertificates--负载均衡-火山引擎

文档中心

立即注册

导航

DescribeCertificates

最近更新时间：2024.10.21 14:07:13首次发布时间：2021.08.31 10:37:28

调用 DescribeCertificates 接口，查询满足指定条件的证书。

使用说明

传入多个请求参数，按照传入的参数进行查询，返回符合所有条件的证书，若没有符合条件的证书，则返回空值。
若请求参数非必选参数均未传入，则按照当前登录账号查询，返回当前账号下的所有证书。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeCertificates	要执行的操作，取值为DescribeCertificates。
Version	String	是	2020-04-01	API版本信息，当前版本为：2020-04-01。
CertificateIds.N	String	否	CertificateIds.1=cert-3tjuxoukkq3vj0ww**&CertificateIds.2=cert-3tigvwjuzu3vj0wt**	证书ID。您可以调用本接口获取证书ID。参数 - N：表示证书的序号，取值范围为1 ～ 100。多个证书ID间使用&连接。
CertificateName	String	否	mycert	证书的名称。
ProjectName	String	否	default	证书所属项目的名称。
TagFilters.N.Key	String	否	TagFilters.1.Key=k1&TagFilters.2.Key=k2&TagFilters.3.Key=k3	标签的标签键。参数 - N：表示标签键的序号，取值范围：1～10。多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与（AND）”，即查询同时添加多个标签键的证书。不允许重复。
TagFilters.N.Values.N	String	否	TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.3.Values.1=v1	标签的标签值。第一个N：表示标签键的序号，取值范围：1～10。第二个N：表示标签值的序号，取值范围：1～3。同一标签键多个标签值之间的关系为逻辑“或(OR)”，即查询同一标签键下添加其中一个标签值的证书。多个标签值之间用&分隔。说明若传入该参数，则必须先传入`TagFilters.N.Key`。传入空字符串时，表示查询标签值为空的证书。
PageNumber	Integer	否	1	列表的页码，默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数，取值范围为1 ～ 100，默认值为10。

返回参数

名称	类型	示例值	描述
RequestId	String	20210811152539010225146063030****	请求ID
PageSize	Integer	20	当前分页的行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	50	符合条件的证书总数。
Certificates	Array of Struct	-	符合条件的证书的详细信息。具体请参见“ Certificates ”。

Certificates

名称	类型	示例值	描述
CertificateId	String	cert-3tigvwjuzu3vj0wt****	证书的ID。
CertificateName	String	mycert01	证书的名称。
Description	String	This is a cert.	证书的描述。
CreateTime	String	2021-08-11T16:37:37Z	证书的创建时间。
ExpiredAt	String	2021-08-11T16:37:37Z	证书的到期时间。
DomainName	String	www.a123.xxx.com	证书的主域名。
SubjectAlternativeNames	List of String	["www.abc.xxx.com","www.abc.xxx.cn"]	证书的备用域名列表。
Listeners	List of String	["lsn-rrhsh4vegr9cv0x591p**","lsn-mioicx8e1jpc5smt1ayy**"]	证书关联的监听器的ID。
ProjectName	String	default	证书所属项目的名称。
ServiceManaged	Boolean	false	是否为托管资源。 true：托管资源。 false：非托管资源。
Tags	Array of Struct	-	标签的详细信息。具体请参见“ Tags”。

名称	类型	示例值	描述
Key	String	k1	标签键。
Value	String	v1	标签值。

请求示例

GET /?Action=DescribeCertificates&Version=2020-04-01&CertificateIds.1=cert-3tjuxoukkq3vj0ww**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeCertificates",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "Certificates": [
            {
                "CertificateId": "cert-3tjuxoukkq3vj0ww****",
                "CertificateName": "test",
                "Description": "test",
                "CreateTime": "2021-08-16T20:53:24Z",
                "ExpiredAt": "2021-08-16T07:59:59Z",
                "DomainName": "www.a123.xxx.com",
                "SubjectAlternativeNames":[
                     "www.abc.xxx.com,",
                     "www.abc.xxx.cn"
                ],
                "Listeners": [
                    "lsn-rrhsh4vegr9cv0x591p****",
                    "lsn-mioicx8e1jpc5smt1ayy****"
                ],
                "ProjectName": "default",
                "ServiceManaged": false,
				        "Tags": [
				            {
				                "Key": "k1",
				                "Value": "v1"
				            }
				        ]
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode	错误码	错误信息	描述
400	InvalidIncorrectOrder.Malformed	The specified index order is malformed.	指定的索引顺序参数格式不合法。
400	InvalidName.Malformed	The specified Name is malformed.	指定的 Name 参数格式不合法。
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	指定的分页参数格式不合法。
400	InvalidTagKey.Malformed	The specified TagKey is malformed.	指定的 TagKey 参数格式不合法。
400	InvalidTagValue.Malformed	The specified TagValue is malformed.	指定的 TagValue 参数格式不合法。
400	LimitExceeded.CertificateId	You've reached the limit on the number of CertificateId that you can operate.	已达到单次可操作证书的资源数量上限。
400	LimitExceeded.TagFilterKey	You've reached the limit on the number of tag keys that you can filter.	已达到单次可指定过滤标签键数量的上限。
400	LimitExceeded.TagFilterValues	You've reached the limit on the number of tag values that you can filter.	已达到单次可指定过滤标签键值数量的上限。