History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
Details of an APIGATEWAY instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| ServiceId | String | The instance ID. |
| ServiceName | String | The instance name. |
| Domain | String | The domain. |
| CertId | String | Certificate id. |
| Protocol | String | The protocol. |
Details of APIGATEWAY instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Region | String | The region. |
| InstanceList | Array of ApiGatewayInstanceDetail | API gateway instance details. |
| TotalCount | Integer | The total number of APIGATEWAY instances in this region. |
| Error | String | Whether to query exceptions. |
Region of associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskResult.
| Name | Type | Description |
|---|---|---|
| Region | String | The region. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The total number of associated cloud resources. |
Associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskResult.
| Name | Type | Description |
|---|---|---|
| ResourceType | String | Supported types: CLB, CDN, WAF, LIVE, VOD, DDOS, TKE, APIGATEWAY, TCB, and TEO (EDGEONE). |
| BindResourceRegionResult | Array of BindResourceRegionResult | The region of associated cloud resources. |
COS instance details - asynchronous association of cloud resource data structure.
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Region | String | Region. |
| InstanceList | Array of CosInstanceDetail | Instance details. |
| TotalCount | Integer | Total number under the region. |
| Error | String | Error message. |
Details of a CSR
Used by actions: DescribeCSRSet.
| Name | Type | Description |
|---|---|---|
| Id | Integer | The CSR ID. Note: This field may return null, indicating that no valid values can be obtained. |
| OwnerUin | String | The account. Note: This field may return null, indicating that no valid values can be obtained. |
| Domain | String | The domain. Note: This field may return null, indicating that no valid values can be obtained. |
| Organization | String | The organization name. Note: This field may return null, indicating that no valid values can be obtained. |
| Department | String | The department. Note: This field may return null, indicating that no valid values can be obtained. |
| String | The email address. Note: This field may return null, indicating that no valid values can be obtained. |
|
| Province | String | The province. Note: This field may return null, indicating that no valid values can be obtained. |
| City | String | The city. Note: This field may return null, indicating that no valid values can be obtained. |
| Country | String | The country or region. Note: This field may return null, indicating that no valid values can be obtained. |
| Remarks | String | The remarks. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | The status. Note: This field may return null, indicating that no valid values can be obtained. |
| CreateTime | String | The creation time. Note: This field may return null, indicating that no valid values can be obtained. |
| EncryptAlgo | String | The encryption algorithm. Note: This field may return null, indicating that no valid values can be obtained. |
| KeyParameter | String | The algorithm parameter. Note: This field may return null, indicating that no valid values can be obtained. |
Details of a CDN instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. |
| CertId | String | The ID of the deployed certificate. |
| Status | String | Domain name status: rejected - the domain name failed the review or its registration has expired/been canceled; processing - deploying; online - started; offline - closed. |
| HttpsBillingSwitch | String | Domain billing status, where on indicates enable and off indicates disable. |
Details of CDN instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The total number of CDN domains in this region. |
| InstanceList | Array of CdnInstanceDetail | CDN domain name details. |
| Error | String | Whether to query exceptions. |
Basic information of the certificate
Used by actions: DescribeCertificateDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| Issuer | String | No | Issuer. |
| Subject | String | No | Issued to. |
| Fingerprint | String | No | Certificate fingerprint. |
| ValidFrom | String | No | Certificate valid period start time. |
| ValidTo | String | No | Certificate valid period end time. |
Certificate and async task IDs
Used by actions: CreateCertificateBindResourceSyncTask.
| Name | Type | Required | Description |
|---|---|---|---|
| CertId | String | No | The certificate ID. |
| TaskId | String | No | The async task ID. |
Details of a CLB certificate
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| CertId | String | The certificate ID. |
| DnsNames | Array of String | The list of domains bound to the certificate. |
| CertCaId | String | Root certificate id. |
| SSLMode | String | Certificate authentication mode: unidirectional one-way authentication, mutual mutual authentication. |
Content of the CertificateExtra parameter. CertificateExtra is an element of Certificates array which is returned by DescribeCertificates.
Used by actions: DescribeCertificate, DescribeCertificateDetail, DescribeCertificates.
| Name | Type | Description |
|---|---|---|
| DomainNumber | String | Quantity of configurable domain names for the certificate. |
| OriginCertificateId | String | Renew the original certificate id. Note: this field may return null, indicating that no valid values can be obtained. |
| ReplacedBy | String | Original ID of the new certificate Note: this field may return null, indicating that no valid values can be obtained. |
| ReplacedFor | String | Reissue certificate id. Note: this field may return null, indicating that no valid values can be obtained. |
| RenewOrder | String | Renewal certificate id. Note: this field may return null, indicating that no valid values can be obtained. |
| SMCert | Integer | Whether it is a China SM certificate. |
| CompanyType | Integer | Company type, valid values: 1 (individual); 2 (company). |
Content of the Certificates parameter returned by DescribeCertificates
Used by actions: DescribeCertificates.
| Name | Type | Description |
|---|---|---|
| OwnerUin | String | User uin. |
| ProjectId | String | Project id. |
| From | String | Certificate source:. trustasia. upload. wosign. sheca. |
| PackageType | String | Certificate package type:. Null: user uploads a certificate (without package type),. 2: trustasia tls rsa ca,. 3: securesite enhanced enterprise edition (ev pro),. 4: securesite enhanced (ev). 5: securesite enterprise professional edition (ov pro). 6: securesite enterprise (ov). 7: securesite enterprise (ov) wildcard. 8: geotrust enhanced (ev). 9: geotrust enterprise (ov) cert. 10: geotrust enterprise (ov) wildcard cert. 11: trustasia domain name-based multiple domain names ssl certificate. 12: trustasia domain name-based (dv) wildcard cert. 13: trustasia enterprise wildcard (ov) ssl certificate (d3). 14: trustasia enterprise (ov) ssl certificate (d3). 15: trustasia enterprise multiple domain names (ov) ssl certificate (d3). 16: trustasia enhanced (ev) ssl certificate (d3). 17: trustasia enhanced multiple domain names (ev) ssl certificate (d3). 18: globalsign enterprise (ov) ssl certificate. 19: globalsign enterprise wildcard (ov) ssl certificate. 20: globalsign enhanced (ev) ssl certificate. 21: trustasia enterprise wildcard multiple domain names (ov) ssl certificate (d3). 22: globalsign enterprise multiple domain names (ov) ssl certificate. 23: globalsign enterprise wildcard multiple domain names (ov) ssl certificate. 24: globalsign enhanced multiple domain name (ev) ssl certificate. 25: wotrus domain name cert. 26: wotrus domain name multiple domain name cert. 27: wotrus domain name wildcard cert. 28: wotrus enterprise cert. 29: wotrus enterprise multi - domain name certificate. 30: wotrus enterprise wildcard certificate. 31: wotrus enhanced certificate. 32: wotrus enhanced multi - domain name certificate. 33: wotrus - national cryptography domain - type certificate. 34: wotrus-national cryptography domain certificate (multiple domain names). 35: wotrus-national cryptography domain certificate (wildcard). 37: wotrus-national cryptography enterprise certificate. 38: wotrus-national cryptography enterprise certificate (multiple domain names). 39: wotrus-national cryptography enterprise certificate (wildcard). 40: wotrus - enhanced national cryptography certificate. 41: wotrus - enhanced national cryptography certificate (multiple domain names). 42: trustasia - domain name type certificate (wildcard multiple domain names). 43: DNSPod - enterprise (ov) ssl certificate. 44: DNSPod - enterprise (ov) wildcard ssl certificate. 45: DNSPod - enterprise (ov) multiple domain names ssl certificate. 46: DNSPod - enhanced (ev) ssl certificate. 47: DNSPod - enhanced (ev) multiple domain names ssl certificate. 48: DNSPod - domain name-based (dv) ssl certificate. 49: DNSPod - domain name-based (dv) wildcard ssl certificate. 50: DNSPod - domain name-based (dv) multiple domain names ssl certificate. 51: DNSPod (national cryptography) - enterprise (ov) ssl certificate. 52: DNSPod (national cryptography) - enterprise (ov) wildcard ssl certificate. 53: DNSPod (national cryptography) - enterprise (ov) multiple domain names ssl certificate. 54: DNSPod (national cryptography) - domain name-based (dv) ssl certificate. 55: DNSPod (national cryptography) - domain name-based (dv) wildcard ssl certificate. 56: DNSPod (national cryptography) - domain name-based (dv) multiple domain names ssl certificate. 57: securesite enterprise professional edition multiple domain names (ov pro). 58: securesite enterprise multiple domain names (ov). 59: securesite enhanced professional edition multiple domain names (ev pro). 60: securesite enhanced multiple domain names (ev). 61: geotrust enhanced multiple domain names (ev). 75: securesite enterprise (ov). 76: securesite enterprise (ov) wildcard. 77: securesite enhanced (ev). 78: geotrust enterprise (ov). 79: geotrust enterprise wildcard (ov). 80: geotrust enhanced (ev). 81: globalsign enterprise (ov) ssl certificate. 82: globalsign enterprise wildcard (ov) ssl certificate. 83: trustasia c1 dv free. 85: globalsign enhanced (ev) ssl certificate. 88: globalsign enterprise wildcard multiple domain names (ov) ssl certificate. 89: globalsign enterprise multiple domain names (ov) ssl certificate. 90: globalsign enhanced multiple domain names (ev) ssl certificate. 91: geotrust enhanced multiple domain names (ev). 92: securesite enterprise pro multiple domain names (ov pro). 93: securesite enterprise multiple domain names (ov). 94: securesite enhanced pro multiple domain names (ev pro). 95: securesite enhanced multiple domain names (ev). 96: securesite ev pro. 97: securesite enterprise professional edition (ov pro). 98: cfca enterprise (ov) ssl certificate. 99: cfca enterprise ov ssl certificate for multiple domain names. 100: cfca ov wildcard ssl certificate. 101: cfca enhanced (ev) ssl certificate. |
| CertificateType | String | Certificate type. ca = client certificate; svr = server certificate. |
| ProductZhName | String | Certificate product name. |
| Domain | String | Primary domain name. |
| Alias | String | Remark name. |
| Status | Integer | Certificate status: 0 = under review, 1 = approved, 2 = review failed, 3 = expired, 4 = dns record added automatically, 5 = enterprise certificate, pending documentation submission, 6 = order cancellation in progress, 7 = canceled, 8 = documents submitted, pending upload of confirmation letter, 9 = certificate revocation in progress, 10 = revoked, 11 = reissue in progress, 12 = pending upload of revocation confirmation letter, 13 = free certificate pending documentation submission, 14 = certificate refunded, 15 = certificate migration in progress. |
| CertificateExtra | CertificateExtra | Certificate extended information. |
| VulnerabilityStatus | String | Vulnerability scanning status: INACTIVE = not enabled, ACTIVE = enabled. |
| StatusMsg | String | Status information. |
| VerifyType | String | Validation type: DNS_AUTO = automatic dns validation, DNS = manual dns validation, FILE = file verification, DNS_PROXY = dns proxy validation, FILE_PROXY = file proxy verification. |
| CertBeginTime | String | Certificate validation time. |
| CertEndTime | String | Certificate expiration time. |
| ValidityPeriod | String | Certificate validity period (month). |
| InsertTime | String | Creation time. |
| CertificateId | String | Certificate id. |
| SubjectAltName | Array of String | Multiple domain names contained in the certificate (including the primary domain name). |
| PackageTypeName | String | Certificate type name. |
| StatusName | String | Status name. |
| IsVip | Boolean | Specifies whether the customer is a vip customer. true indicates yes and false indicates no. |
| IsDv | Boolean | Specifies whether it is a dv version certificate. true indicates yes and false indicates no. |
| IsWildcard | Boolean | Specifies whether it is a wildcard domain name certificate. true indicates yes and false indicates no. |
| IsVulnerability | Boolean | Whether the vulnerability scanning feature is enabled. |
| RenewAble | Boolean | Whether it is renewable. |
| ProjectInfo | ProjectInfo | Project information. |
| BoundResource | Array of String | Associated cloud resources are temporarily unavailable. |
| Deployable | Boolean | Whether it can be deployed. |
| Tags | Array of Tags | Tag list. |
| IsIgnore | Boolean | Whether expiration notice has been ignored. |
| IsSM | Boolean | Whether it is a China SM certificate. |
| EncryptAlgorithm | String | Certificate algorithm. |
| CAEncryptAlgorithms | Array of String | Encryption algorithm for upload ca certificate. |
| CAEndTimes | Array of String | Expiration time for upload ca certificate. |
| CACommonNames | Array of String | Common name of the upload ca certificate. |
| PreAuditInfo | PreAuditInfo | Certificate prereview information. |
| AutoRenewFlag | Integer | Whether to auto-renew. |
| HostingStatus | Integer | Hosting status: 0, hosting; 5, resource replacement; 10, hosting completed; -1, not hosted. |
| HostingCompleteTime | String | Hosting completion time. |
| HostingRenewCertId | String | Manage the new certificate id. |
| HasRenewOrder | String | Existing renewal certificate id. |
| ReplaceOriCertIsDelete | Boolean | Indicates whether the original certificate is deleted during reissue. |
| IsExpiring | Boolean | Indicates whether it is about to expire. a certificate is about to expire if it will expire within 30 days. |
| DVAuthDeadline | String | Add validation expiration date for DV certificate |
| ValidationPassedTime | String | Domain verification passed time. |
| CertSANs | Array of String | Multiple domain names associated with the certificate. |
| AwaitingValidationMsg | String | Domain verification rejection information. |
| AllowDownload | Boolean | Whether to allow downloading. |
| IsDNSPODResolve | Boolean | Whether all certificate domain names are managed and resolved by dnspod. |
| IsPackage | Boolean | Whether the certificate is purchased with benefit points. |
| KeyPasswordCustomFlag | Boolean | Whether there is a private key password. |
| SupportDownloadType | SupportDownloadType | Types of web servers supported for download: nginx, apache, iis, tomcat, jks, root, other. |
| CertRevokedTime | String | Certificate revocation completion time. |
| HostingResourceTypes | Array of String | Hosted resource type list. |
| HostingConfig | HostingConfig | Managed configuration information. |
Details of a CLB instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| LoadBalancerId | String | The CLB instance ID. |
| LoadBalancerName | String | The CLB instance name. |
| Listeners | Array of ClbListener | CLB listener list. |
Details of CLB instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Region | String | The region. |
| InstanceList | Array of ClbInstanceDetail | CLB instance details. |
| TotalCount | Integer | The total number of CLB instances in this region. |
| Error | String | Whether to query exceptions. |
Details of a CLB instance listener
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| ListenerId | String | The listener ID. |
| ListenerName | String | The listener name. |
| SniSwitch | Integer | Whether to enable SNI. Valid values: 1 (enable) and 0 (disable). |
| Protocol | String | The listener protocol type. Valid values: HTTPS and TCP_SSL. |
| Certificate | Certificate | Data of certificate bound to the listener. |
| Rules | Array of ClbListenerRule | List of listener rules. |
| NoMatchDomains | Array of String | Domain list not matched. |
Details of a CLB listener rule
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| LocationId | String | The rule ID. |
| Domain | String | The domains bound. |
| IsMatch | Boolean | Whether the rule matches the domains to be associated with a certificate. |
| Certificate | Certificate | Certificate data bound to the rule. |
| NoMatchDomains | Array of String | Domain list not matched. |
| Url | String | Rule binding path. |
COS instance description.
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | Domain name. |
| CertId | String | Bound certificate id. |
| Status | String | ENABLED: domain name online status. DISABLED: domain name offline status. |
| Bucket | String | bucket name. |
| Region | String | bucket region. |
Details of a DDOS instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. |
| InstanceId | String | The instance ID. |
| Protocol | String | The protocol type. |
| CertId | String | Certificate id. |
| VirtualPort | String | The forwarding port. |
Details of DDOS instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The total number of DDOS instances in this region. |
| InstanceList | Array of DdosInstanceDetail | DDOS instance details. |
| Error | String | Whether to query exceptions. |
Managed records.
Used by actions: DescribeHostUploadUpdateRecordDetail.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Total number. |
| SuccessTotalCount | Integer | Total successes |
| FailedTotalCount | Integer | Total failed deployments. |
| RunningTotalCount | Integer | Deployment in progress total number. |
| Type | Integer | Deployment record type 0 specifies deployment, 1 indicates rollback. |
| RecordDetailList | Array of DeployRecordList | Deployment record detail list. |
| Status | Integer | Hosted resource deployment state: 0 (awaiting deployment), 1 (deployment successful), 2 (deployment failed), 3 (deploying), 4 (rollback successful), 5 (rollback failure). |
| CreateTime | String | Managed resource creation time. |
Deployment record details.
Used by actions: DescribeHostUploadUpdateRecordDetail.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Deployment record detail ID. |
| OldCertId | String | Bound certificate ID. |
| InstanceId | String | Deployment instance ID. |
| InstanceName | String | Specifies the deployment instance name. |
| ListenerId | String | Deploy the listener ID. |
| Domains | Array of String | Deployment domain name list. |
| Protocol | String | Deploy listener protocol. |
| Status | Integer | Deployment state. |
| ErrorMsg | String | Deployment error information. |
| CreateTime | String | Describes the creation time of the deployment record detail. |
| UpdateTime | String | Specifies the last update time of the deployment record detail. |
| ListenerName | String | Deploy listener name. |
| SniSwitch | Integer | Whether SNI is enabled. |
| Bucket | String | COS bucket name. |
| Namespace | String | Namespace name. |
| SecretName | String | The secret name. |
| Port | Integer | Port |
| Region | String | Deployed TCB region. |
| Forward | Integer | CLB type. valid values: 0 (classic clb); 1 (application clb). |
| SSLMode | String | Certificate authentication mode: UNIDIRECTIONAL for one-way authentication, MUTUAL for MUTUAL authentication. |
| ResourceType | String | Deployment resource type. |
Managed record detailed information.
Used by actions: DescribeHostUploadUpdateRecordDetail.
| Name | Type | Description |
|---|---|---|
| ResourceType | String | Deployment resource type. |
| List | Array of DeployRecordItem | Deployment resource detail list. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total count of deployment resources. |
Content of the DvAuthDetail parameter returned by DescribeCertificates
Used by actions: DescribeCertificate, DescribeCertificateDetail.
| Name | Type | Description |
|---|---|---|
| DvAuthKey | String | Certificate domain name verification record key. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthValue | String | Certificate domain name verification record value. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthDomain | String | Certificate domain name verification domain value. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthPath | String | Certificate domain name verification file path, used only for file and file_proxy. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthKeySubDomain | String | Certificate domain name verification subdomain. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuths | Array of DvAuths | Certificate domain verification information; multiple domain verifications use this field. Note: this field may return null, indicating that no valid values can be obtained. |
Content of the DvAuths parameter
Used by actions: DescribeCertificate, DescribeCertificateDetail.
| Name | Type | Description |
|---|---|---|
| DvAuthKey | String | Certificate domain name verification record key. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthValue | String | Certificate domain name verification record value. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthDomain | String | Certificate domain name verification domain value. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthPath | String | Certificate domain name verification file path, used only for file and file_proxy. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthSubDomain | String | Certificate domain name verification subdomain. Note: this field may return null, indicating that no valid values can be obtained. |
| DvAuthVerifyType | String | Certificate domain verification type, valid values:. TXT: add txt record for dns domain verification. FILE: domain file verification. CNAME: add cname record for dns domain verification. Note: this field may return null, indicating that no valid values can be obtained. |
Errors
Used by actions: DescribeCertificateBindResourceTaskResult.
| Name | Type | Description |
|---|---|---|
| Code | String | The error code. Note: This field may return null, indicating that no valid values can be obtained. |
| Message | String | The error message. Note: This field may return null, indicating that no valid values can be obtained. |
List of filter parameters
Used by actions: DescribeHostTeoInstanceList.
| Name | Type | Required | Description |
|---|---|---|---|
| FilterKey | String | Yes | The key of the filter parameter. |
| FilterValue | String | Yes | The value of the filter parameter. |
Cloud-native gateway certificate information
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Id | String | Gateway certificate ID Note: This field may return null, indicating that no valid value can be obtained. |
| Name | String | Gateway certificate information Note: This field may return null, indicating that no valid value can be obtained. |
| BindDomains | Array of String | Bound domain name Note: This field may return null, indicating that no valid value can be obtained. |
| CertSource | String | Certificate source Note: This field may return null, indicating that no valid value can be obtained. |
| CertId | String | SSL certificate ID that is currently bound Note: This field may return null, indicating that no valid value can be obtained. |
Managed configuration.
Used by actions: DescribeCertificates.
| Name | Type | Required | Description |
|---|---|---|---|
| ReplaceTime | Integer | No | Hosted resource replacement time, defaults to 30 days before the certificate expiration if there is a renewal certificate, then replace. Note: this field may return null, indicating that no valid values can be obtained. |
| MessageTypes | Array of Integer | No | Hosted send message type: 0, reminder message before hosted starts (you will receive this reminder message even if there is no renewal certificate); 1, reminder message when hosted starts (you will receive the message reminder only if there is a renewal certificate); 2, reminder message when hosted resource replacement fails; 3 reminder message when hosted resource replacement succeeds. Note: this field may return null, indicating that no valid values can be obtained. |
| ReplaceStartTime | String | No | Resource replacement start time. |
| ReplaceEndTime | String | No | Resource replacement end time. |
Details of a LIVE instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. |
| CertId | String | The ID of the associated certificate. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | The status. Valid values: -1: No certificate is associated with the domain.1: HTTPS is enabled for the domain.0: HTTPS is disabled for the domain. |
Details of LIVE instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| TotalCount | Integer | The total number of LIVE instances in this region. |
| InstanceList | Array of LiveInstanceDetail | The list of LIVE instances. Note: This field may return null, indicating that no valid values can be obtained. |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
Certificate operation logs
Used by actions: DescribeCertificateOperateLogs.
| Name | Type | Description |
|---|---|---|
| Action | String | Action performed on logs |
| CreatedOn | Timestamp | Time when the action is performed |
| Uin | String | Root account. Note: this field may return null, indicating that no valid values can be obtained. |
| SubAccountUin | String | Sub-Account. Note: this field may return null, indicating that no valid values can be obtained. |
| CertId | String | Certificate id. Note: this field may return null, indicating that no valid values can be obtained. |
| Type | String | Each operation type corresponds to a specific operation description. the following is a textual explanation of each operation type and its description:. 1. apply: indicates applying for a free cert. 2. delete: indicates a deletion. 3. download - represents the download operation. 4. upload: indicates an upload operation. 5. revoke: indicates revoking a cert. 6. cancelRevoke - indicates canceling the revocation operation. 7. updateAlias - indicates updating the remark information. 8. changeProject - indicates assigning the certificate to a certain project. 9. uploadConfirmLetter - indicates uploading the confirmation letter. 10. cancel - indicates canceling the order operation. 11. replace - specifies reissuing a certificate. 12. downloadConfirmLetter - specifies downloading a certificate revocation confirmation letter. 13. editRevokeLetter - specifies uploading a certificate revocation confirmation letter. 14. renewVIP - specifies renewing a paid certificate. 15. applyVIP - specifies applying for a paid certificate. 16. submitInfo - specifies submitting documentation. 17. downloadConfirmLetter - specifies downloading the confirmation letter template. 18. uploadFromYunAPI - indicates uploading via the cloud api. 19. transferIn - indicates the certificate transfer to operation. 20. transferOut - indicates the certificate transfer operation. 21. refund - indicates applying for a refund. 22. multiYearsRenew - indicates multi-year auto-renewal. 23. modifyDownloadLimit - indicates modifying the download limit switch. 24. issued - indicates certificate issuance. 25. domainValidationPassed - indicates domain verification completed. 26. Resubmit - indicates reapplying for a certificate. Note: this field may return null, indicating that no valid values can be obtained. |
List of prereview information
Used by actions: DescribeCertificates.
| Name | Type | Description |
|---|---|---|
| TotalPeriod | Integer | Total number of years of the certificate Note: This field may return null, indicating that no valid values can be obtained. |
| NowPeriod | Integer | Current year of the certificate Note: This field may return null, indicating that no valid values can be obtained. |
| ManagerId | String | Certificate prereview manager ID Note: This field may return null, indicating that no valid values can be obtained. |
Content of the ProjectInfo parameter. ProjectInfo is an element of Certificates array which is returned by DescribeCertificates.
Used by actions: DescribeCertificates.
| Name | Type | Description |
|---|---|---|
| ProjectName | String | Project name Note: this field may return null, indicating that no valid values can be obtained. |
| ProjectCreatorUin | Integer | UIN of the project creator Note: this field may return null, indicating that no valid values can be obtained. |
| ProjectCreateTime | String | Project creation time Note: this field may return null, indicating that no valid values can be obtained. |
| ProjectResume | String | Brief project information Note: this field may return null, indicating that no valid values can be obtained. |
| OwnerUin | Integer | User UIN Note: this field may return null, indicating that no valid values can be obtained. |
| ProjectId | String | Project ID Note: this field may return null, indicating that no valid values can be obtained. |
Cloud resource region list
Used by actions: UpdateCertificateInstance, UploadUpdateCertificateInstance.
| Name | Type | Required | Description |
|---|---|---|---|
| ResourceType | String | No | Cloud resource types, which support clb, waf, api gateway, cos, tke, tse, and tcb. |
| Regions | Array of String | No | Region list |
Root certificate
Used by actions: DescribeCertificateDetail.
| Name | Type | Description |
|---|---|---|
| Sign | String | Chinese SM signature certificate Note: This field may return null, indicating that no valid values can be obtained. |
| Encrypt | String | Chinese SM encryption certificate Note: This field may return null, indicating that no valid values can be obtained. |
| Standard | String | Standard certificate Note: This field may return null, indicating that no valid values can be obtained. |
Content of the SubmittedData parameter returned by DescribeCertificates
Used by actions: DescribeCertificate, DescribeCertificateDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| CsrType | String | No | CSR type. online: CSR generated online; parse: CSR pastedNote: this field may return null, indicating that no valid values can be obtained. |
| CsrContent | String | No | CSR content Note: this field may return null, indicating that no valid values can be obtained. |
| CertificateDomain | String | No | Domain name information Note: this field may return null, indicating that no valid values can be obtained. |
| DomainList | Array of String | No | DNS information Note: this field may return null, indicating that no valid values can be obtained. |
| KeyPassword | String | No | Password of the private key Note: this field may return null, indicating that no valid values can be obtained. |
| OrganizationName | String | No | Enterprise or unit name Note: this field may return null, indicating that no valid values can be obtained. |
| OrganizationDivision | String | No | Division Note: this field may return null, indicating that no valid values can be obtained. |
| OrganizationAddress | String | No | Address Note: this field may return null, indicating that no valid values can be obtained. |
| OrganizationCountry | String | No | Country Note: this field may return null, indicating that no valid values can be obtained. |
| OrganizationCity | String | No | City Note: this field may return null, indicating that no valid values can be obtained. |
| OrganizationRegion | String | No | Province Note: this field may return null, indicating that no valid values can be obtained. |
| PostalCode | String | No | Postal code Note: this field may return null, indicating that no valid values can be obtained. |
| PhoneAreaCode | String | No | Area code of the fixed-line phone number Note: this field may return null, indicating that no valid values can be obtained. |
| PhoneNumber | String | No | Fixed-line phone number Note: this field may return null, indicating that no valid values can be obtained. |
| AdminFirstName | String | No | First name of the administrator Note: this field may return null, indicating that no valid values can be obtained. |
| AdminLastName | String | No | Last name of the administrator Note: this field may return null, indicating that no valid values can be obtained. |
| AdminPhoneNum | String | No | Phone number of the administrator Note: this field may return null, indicating that no valid values can be obtained. |
| AdminEmail | String | No | Email of the administrator Note: this field may return null, indicating that no valid values can be obtained. |
| AdminPosition | String | No | Position of the administrator Note: this field may return null, indicating that no valid values can be obtained. |
| ContactFirstName | String | No | First name of the contact Note: this field may return null, indicating that no valid values can be obtained. |
| ContactLastName | String | No | Last name of the contact Note: this field may return null, indicating that no valid values can be obtained. |
| ContactNumber | String | No | Phone number of the contact Note: this field may return null, indicating that no valid values can be obtained. |
| ContactEmail | String | No | Email of the contact Note: this field may return null, indicating that no valid values can be obtained. |
| ContactPosition | String | No | Position of the contact Note: this field may return null, indicating that no valid values can be obtained. |
| VerifyType | String | No | Validation type Note: this field may return null, indicating that no valid values can be obtained. |
Supported types for download.
Used by actions: DescribeCertificates.
| Name | Type | Description |
|---|---|---|
| NGINX | Boolean | Whether the available format of nginx can be downloaded. |
| APACHE | Boolean | Whether the available format of apache can be downloaded. |
| TOMCAT | Boolean | Whether the available format of tomcat can be downloaded. |
| IIS | Boolean | Whether the available format of iis can be downloaded. |
| JKS | Boolean | Indicates whether the jks format can be downloaded. |
| OTHER | Boolean | Indicates whether other formats can be downloaded. |
| ROOT | Boolean | Indicates whether the root certificate can be downloaded. |
Result of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskResult.
| Name | Type | Description |
|---|---|---|
| TaskId | String | The task ID. |
| BindResourceResult | Array of BindResourceResult | The associated cloud resources. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | The status of the async task. Valid values: 0 for querying, 1 for successful, and 2 for abnormal. If the status is 1, the result of BindResourceResult will be displayed; if the status is 2, the error causes will be displayed. |
| Error | Error | The error occurred when querying the associated cloud resources. Note: This field may return null, indicating that no valid values can be obtained. |
| CacheTime | String | The cache time of the current result. |
TCB access instances
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | Integer | The status. Note: This field may return null, indicating that no valid values can be obtained. |
| UnionStatus | Integer | The unified domain status. Note: This field may return null, indicating that no valid values can be obtained. |
| IsPreempted | Boolean | Whether the domain is preempted. A preempted domain is one that is already associated with another environment. It must be disassociated or re-associated first. Note: This field may return null, indicating that no valid values can be obtained. |
| ICPStatus | Integer | Whether the domain is added to the ICP blocklist. Valid values: 0 for no and 1 for yes.Note: This field may return null, indicating that no valid values can be obtained. |
| OldCertificateId | String | The ID of the associated certificate. Note: This field may return null, indicating that no valid values can be obtained. |
Details of TCB access instances
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of TCBAccessInstance | The list of instances. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The instance count. Note: This field may return null, indicating that no valid values can be obtained. |
Details of TCB environment instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| ID | String | The unique ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Source | String | The source. Note: This field may return null, indicating that no valid values can be obtained. |
| Name | String | The name. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | The status. Note: This field may return null, indicating that no valid values can be obtained. |
Details of TCB instances by environment - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Environment | TCBEnvironment | The TCB environment. Note: This field may return null, indicating that no valid values can be obtained. |
| AccessService | TCBAccessService | The access service. Note: This field may return null, indicating that no valid values can be obtained. |
| HostService | TCBHostService | Whether static hosting is used. Note: This field may return null, indicating that no valid values can be obtained. |
Details of TCB service instances subject to static hosting
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | The status. Note: This field may return null, indicating that no valid values can be obtained. |
| DNSStatus | String | The resolution status. Note: This field may return null, indicating that no valid values can be obtained. |
| OldCertificateId | String | The ID of the associated certificate. Note: This field may return null, indicating that no valid values can be obtained. |
List of TCB services subject to static hosting
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of TCBHostInstance | The list of instances. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The instance count. Note: This field may return null, indicating that no valid values can be obtained. |
Details of TCB instances by region - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Region | String | The region. |
| Environments | Array of TCBEnvironments | The list of TCB environments. Note: This field may return null, indicating that no valid values can be obtained. |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
TSE instance details
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| GatewayId | String | Gateway ID Note: This field may return null, indicating that no valid value can be obtained. |
| GatewayName | String | Gateway name Note: This field may return null, indicating that no valid value can be obtained. |
| CertificateList | Array of GatewayCertificate | Gateway certificate list Note: This field may return null, indicating that no valid value can be obtained. |
TSE instance details - asynchronously associated cloud resource data structure
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of TSEInstanceDetail | TSE instance details Note: This field may return null, indicating that no valid value can be obtained. |
| TotalCount | Integer | Total TSE instances in this region |
| Region | String | Region |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
Tag
Used by actions: CreateCSR, CreateCertificate, DescribeCertificate, DescribeCertificateDetail, DescribeCertificates, UpdateCertificateInstance, UploadCertificate.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
Details of TEO instances
Used by actions: DescribeCertificateBindResourceTaskDetail, DescribeHostTeoInstanceList.
| Name | Type | Description |
|---|---|---|
| Host | String | The domain. |
| CertId | String | The certificate ID. |
| ZoneId | String | The AZ ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Status | String | Domain status.Deployed: deployed;.Processing: deploying;.Applying: applying;.Failed: application failed;.Issued: binding failed. |
Details of the EDGEONE instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of TeoInstanceDetail | The list of EDGEONE instances. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The total number of EDGEONE instances. |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
Details of a TKE Ingress instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| IngressName | String | The Ingress name. |
| TlsDomains | Array of String | The list of TLS domains. |
| Domains | Array of String | The list of Ingress domains. |
Details of a TKE instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| ClusterId | String | The cluster ID. |
| ClusterName | String | The cluster name. |
| NamespaceList | Array of TkeNameSpaceDetail | The list of cluster namespaces. |
| ClusterType | String | The cluster type. |
| ClusterVersion | String | The cluster version. |
Details of TKE instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Region | String | The region. |
| InstanceList | Array of TkeInstanceDetail | The list of TKE instances. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The total number of TKE instances in this region. |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
Details of a TKE namespace
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Name | String | The namespace name. |
| SecretList | Array of TkeSecretDetail | The secret list. |
Details of a TKE secret
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Name | String | The secret name. |
| CertId | String | The certificate ID. |
| IngressList | Array of TkeIngressDetail | The Ingress list. |
| NoMatchDomains | Array of String | The list of domains that do not match the new certificate. Note: This field may return null, indicating that no valid values can be obtained. |
Update record details
Used by actions: DescribeHostUpdateRecordDetail.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Update detail record id. |
| CertId | String | New and old certificate update - new certificate id. |
| OldCertId | String | Old and new certificate update - old certificate id. |
| Domains | Array of String | Deployment domain name list Note: This field may return null, indicating that no valid value can be obtained. |
| ResourceType | String | Type of cloud resource for updating old and new certs. - clb. - cdn. - ddos. - live. - vod. - waf. - apigateway. - teo. - tke. - cos. - tse. - tcb. |
| Region | String | Deployment region Note: This field may return null, indicating that no valid value can be obtained. |
| Status | Integer | Deployment status. valid values:. 0: To be deployed. 1: Deployment successful. 2: Deployment failed. 3: Deploying. 4: Rollback succeeded. 5: Rollback failure. 6: No resource, no need for deployment. |
| ErrorMsg | String | Deployment error message Note: This field may return null, indicating that no valid value can be obtained. |
| CreateTime | String | Deployment time |
| UpdateTime | String | Last update time |
| InstanceId | String | Deployment instance ID Note: This field may return null, indicating that no valid value can be obtained. |
| InstanceName | String | Deployment instance name Note: This field may return null, indicating that no valid value can be obtained. |
| ListenerId | String | Deployment listener ID (only for CLB) Note: This field may return null, indicating that no valid value can be obtained. |
| ListenerName | String | Deployment listener name (only for CLB) Note: This field may return null, indicating that no valid value can be obtained. |
| Protocol | String | Protocol Note: This field may return null, indicating that no valid value can be obtained. |
| SniSwitch | Integer | Whether SNI is enabled (only for CLB) Note: This field may return null, indicating that no valid value can be obtained. |
| Bucket | String | Bucket name (only for COS) Note: This field may return null, indicating that no valid value can be obtained. |
| Port | Integer | Port Note: This field may return null, indicating that no valid value can be obtained. |
| Namespace | String | Namespace (only for TKE) Note: This field may return null, indicating that no valid value can be obtained. |
| SecretName | String | Secret name (only for TKE) Note: This field may return null, indicating that no valid value can be obtained. |
| EnvId | String | Environment ID Note: This field may return null, indicating that no valid value can be obtained. |
| TCBType | String | TCB deployment type Note: This field may return null, indicating that no valid value can be obtained. |
| Url | String | Listener url (only for CLB). Note: this field may return null, indicating that no valid values can be obtained. |
Details of update records.
Used by actions: DescribeHostUpdateRecordDetail.
| Name | Type | Description |
|---|---|---|
| ResourceType | String | Type of cloud resource for updating old and new certs. - clb. - cdn. - ddos. - live. - vod. - waf. - apigateway. - teo. - tke. - cos. - tse. - tcb. |
| List | Array of UpdateRecordDetail | The update details of the cloud resource. |
| TotalCount | Integer | The update of the total number of cloud resources. |
Deployment record information
Used by actions: DescribeHostUpdateRecord.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Record ID |
| CertId | String | New certificate ID |
| OldCertId | String | Old certificate ID |
| ResourceTypes | Array of String | Deployment resource type list |
| Regions | Array of String | Deployment region list Note: This field may return null, indicating that no valid value can be obtained. |
| Status | Integer | Deployment status |
| CreateTime | String | Deployment time |
| UpdateTime | String | Last update time |
Update the progress of asynchronous task.
Used by actions: UpdateCertificateInstance, UploadUpdateCertificateInstance.
| Name | Type | Description |
|---|---|---|
| ResourceType | String | Resource type. Note: this field may return null, indicating that no valid values can be obtained. |
| UpdateSyncProgressRegions | Array of UpdateSyncProgressRegion | Region result list. Note: this field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Asynchronous update progress status: 0, pending, 1 processed, 3 processing. Note: this field may return null, indicating that no valid values can be obtained. |
Update the progress of asynchronous task.
Used by actions: UpdateCertificateInstance, UploadUpdateCertificateInstance.
| Name | Type | Description |
|---|---|---|
| Region | String | Resource type. Note: this field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total number . Note: this field may return null, indicating that no valid values can be obtained. |
| OffsetCount | Integer | Quantity of executions completed. Note: this field may return null, indicating that no valid values can be obtained. |
| Status | Integer | Asynchronous update progress status: 0, pending, 1 processed, 3 processing. Note: this field may return null, indicating that no valid values can be obtained. |
Deployment record list information.
Used by actions: DescribeHostUploadUpdateRecord.
| Name | Type | Description |
|---|---|---|
| Id | Integer | Record ID |
| OldCertId | String | Original certificate ID |
| ResourceTypes | Array of String | Deployment resource type list. |
| Status | Integer | Deployment state. |
| CreateTime | String | Deployment time. |
| UpdateTime | String | Last update time. |
Details of VOD instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| InstanceList | Array of VodInstanceDetail | The list of VOD instances. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The total number of VOD instances in this region. |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
Details of a VOD instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. |
| CertId | String | The certificate ID. |
Details of a WAF instance
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Domain | String | The domain. |
| CertId | String | The certificate ID. Note: This field may return null, indicating that no valid values can be obtained. |
| Keepalive | Integer | Whether to keep the persistent connection. Note: This field may return null, indicating that no valid values can be obtained. |
Details of WAF instances - data structure of an async task for querying associated cloud resources
Used by actions: DescribeCertificateBindResourceTaskDetail.
| Name | Type | Description |
|---|---|---|
| Region | String | The region. |
| InstanceList | Array of WafInstanceDetail | The list of WAF instances. Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | The total number of WAF instances in this region. |
| Error | String | Whether to query exceptions. Note: this field may return null, indicating that no valid values can be obtained. |
文档反馈