Display the certificate corresponding to the domain name - DescribeWafDomainCertificateInfo

Overview

Display the certificate corresponding to the domain name

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeWafDomainCertificateInfo`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
Domain	string	To query the domain name, search for all when it is empty.	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
TotalCount	int	Certificate Quantity	No
CertificateInfo	array[DoaminCertificateInfo]	Certificate details list, refer to DoaminCertificateInfo	No

Data Model

DoaminCertificateInfo

Field Name	Type	Description Information	Required
CertificateID	int	Certificate ID	No
CertificateName	string	Certificate Name	No
Domain	string	Primary Domain of the Certificate	No
UploadTime	string	Certificate storage time, in utc time format, such as: 2020-02-06T18:46:17+08:00	No
ExpireTime	string	Expiration Time	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeWafDomainCertificateInfo
&ProjectId=org-xxx
&Domain=www.test.com

Response Example

{
  "Action": "DescribeWafDomainCertificateInfoResponse",
  "CertificateInfo": [
    {
      "CertificateID": 834,
      "CertificateName": "test",
      "Domain": "test.com",
      "UploadTime": "2020-02-06T18:46:17+08:00"
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

DescribeWafDomainBlackList DescribeWafDomainHostInfo