tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2024-12-02 16:45:59

    ApiGatewayInstanceDetail

    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 The certificate ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    Protocol String The protocol.

    ApiGatewayInstanceList

    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 The list of APIGATEWAY instances.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer The total number of APIGATEWAY instances in this region.

    BindResourceRegionResult

    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.

    BindResourceResult

    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.

    CSRItem

    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.
    Email 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.

    CdnInstanceDetail

    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 The status of the domain.
    HttpsBillingSwitch String The billing status of the domain.

    CdnInstanceList

    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 The list of CDN domains.
    Note: This field may return null, indicating that no valid values can be obtained.

    CertTaskId

    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.

    Certificate

    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 The root certificate ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    SSLMode String The authentication type. Valid values: UNIDIRECTIONAL (one-way authentication) and MUTUAL (two-way authentication).
    Note: This field may return null, indicating that no valid values can be obtained.

    CertificateExtra

    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 Number of domain names which can be associated with the certificate
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginCertificateId String 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 New ID of the new certificate
    Note: this field may return null, indicating that no valid values can be obtained.
    RenewOrder String Certificate ID of the new order
    Note: this field may return null, indicating that no valid values can be obtained.
    SMCert Integer Whether the certificate is a Chinese SM certificate.
    Note: This field may return null, indicating that no valid values can be obtained.
    CompanyType Integer Company type
    Note: This field may return null, indicating that no valid value can be obtained.

    Certificates

    Content of the Certificates parameter returned by DescribeCertificates

    Used by actions: DescribeCertificates.

    Name Type Description
    OwnerUin String 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.
    From String Certificate source
    Note: this field may return null, indicating that no valid values can be obtained.
    PackageType String The certificate plan type. Valid values:
    null: Certificates uploaded by users (no plan type)
    1: GeoTrust DV SSL CA - G3; 2: TrustAsia TLS RSA CA; 3: SecureSite EV Pro; 4: SecureSite EV; 5: SecureSite OV Pro; 6: SecureSite OV; 7: SecureSite OV wildcard; 8: GeoTrust EV; 9: GeoTrust OV; 10: GeoTrust OV wildcard; 11: TrustAsia DV multi-domain; 12: TrustAsia DV wildcard; 13: TrustAsia OV wildcard D3; 14: TrustAsia OV D3; 15: TrustAsia OV multi-domain D3; 16: TrustAsia EV D3; 17: TrustAsia EV multi-domain D3; 18: GlobalSign OV; 19: GlobalSign OV wildcard; 20: GlobalSign EV; 21: TrustAsia OV wildcard multi-domain D3; 22: GlobalSign OV multi-domain; 23: GlobalSign OV wildcard multi-domain; 24: GlobalSign EV multi-domain
    Note: This field may return null, indicating that no valid values can be obtained.
    CertificateType String Certificate type. CA: client certificate; SVR: server certificate
    Note: this field may return null, indicating that no valid values can be obtained.
    ProductZhName String Issuer
    Note: this field may return null, indicating that no valid values can be obtained.
    Domain String Primary domain name
    Note: this field may return null, indicating that no valid values can be obtained.
    Alias String Alias
    Note: this field may return null, indicating that no valid values can be obtained.
    Status Integer Status. 0: Reviewing; 1: Approved; 2: Unapproved; 3: Expired; 4: DNS record added for domain names of the DNS_AUTO verification type; 5: Enterprise-grade certificate, pending submission; 6: Canceling order; 7: Canceled; 8: Information submitted, pending confirmation letter upload; 9: Revoking certificate; 10: Revoked; 11: Reissuing; 12: Pending revocation confirmation letter upload; 13: Pending information submission for the free certificate; 14: Refunded.
    Note: This field may return null, indicating that no valid values can be obtained.
    CertificateExtra CertificateExtra Extended information of the certificate
    Note: this field may return null, indicating that no valid values can be obtained.
    VulnerabilityStatus String Vulnerability scanning status. INACTIVE: not activated; ACTIVE: activated
    Note: this field may return null, indicating that no valid values can be obtained.
    StatusMsg String Status information
    Note: this field may return null, indicating that no valid values can be obtained.
    VerifyType String Validation type. DNS_AUTO: automatic DNS validation; DNS: manual DNS validation; FILE: file validation; EMAIL: email validation
    Note: this field may return null, indicating that no valid values can be obtained.
    CertBeginTime String Time when the certificate takes effect
    Note: this field may return null, indicating that no valid values can be obtained.
    CertEndTime String Time when the certificate expires
    Note: this field may return null, indicating that no valid values can be obtained.
    ValidityPeriod String Validity period of the certificate, in months
    Note: this field may return null, indicating that no valid values can be obtained.
    InsertTime String Creation time
    Note: this field may return null, indicating that no valid values can be obtained.
    CertificateId String Certificate ID
    Note: this field may return null, indicating that no valid values can be obtained.
    SubjectAltName Array of String Domain names associated with the certificate (including the primary domain name)
    Note: this field may return null, indicating that no valid values can be obtained.
    PackageTypeName String Certificate type name
    Note: this field may return null, indicating that no valid values can be obtained.
    StatusName String Status description
    Note: this field may return null, indicating that no valid values can be obtained.
    IsVip Boolean Whether the customer is a VIP customer
    Note: this field may return null, indicating that no valid values can be obtained.
    IsDv Boolean Whether the certificate is a DV certificate
    Note: this field may return null, indicating that no valid values can be obtained.
    IsWildcard Boolean Whether the certificate is a wildcard certificate
    Note: this field may return null, indicating that no valid values can be obtained.
    IsVulnerability Boolean Whether the vulnerability scanning feature is enabled
    Note: this field may return null, indicating that no valid values can be obtained.
    RenewAble Boolean Whether it can be renewed
    Note: This field may return null, indicating that no valid value can be obtained.
    ProjectInfo ProjectInfo Project information
    Note: this field may return null, indicating that no valid values can be obtained.
    BoundResource Array of String Associated Tencent Cloud services. Currently, this parameter is unavailable.
    Note: this field may return null, indicating that no valid values can be obtained.
    Deployable Boolean Whether the certificate can be deployed
    Note: this field may return null, indicating that no valid values can be obtained.
    Tags Array of Tags List of tags
    Note: this field may return null, indicating that no valid values can be obtained.
    IsIgnore Boolean Whether the expiration notification was ignored
    Note: This field may return null, indicating that no valid values can be obtained.
    IsSM Boolean Whether the certificate is a Chinese SM certificate
    Note: This field may return null, indicating that no valid values can be obtained.
    EncryptAlgorithm String Certificate algorithm
    Note: This field may return null, indicating that no valid values can be obtained.
    CAEncryptAlgorithms Array of String Encryption algorithm of the uploaded CA certificate
    Note: This field may return null, indicating that no valid values can be obtained.
    CAEndTimes Array of String Expiration time of the uploaded CA certificate
    Note: This field may return null, indicating that no valid values can be obtained.
    CACommonNames Array of String Generic name of the uploaded CA certificate
    Note: This field may return null, indicating that no valid values can be obtained.
    PreAuditInfo PreAuditInfo Prereview information of the certificate
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoRenewFlag Integer Whether auto-renewal is enabled.
    Note: This field may return null, indicating that no valid value can be obtained.
    HostingStatus Integer The hosting status. Valid values: 0 (hosting), 5 (replacing resources), 10 (hosting completed), and -1 (not hosted).
    Note: This field may return null, indicating that no valid values can be obtained.
    HostingCompleteTime String The hosting completion time.
    Note: This field may return null, indicating that no valid values can be obtained.
    HostingRenewCertId String The hosted new certificate ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    HasRenewOrder String Existing renewed certificate ID
    Note: This field may return null, indicating that no valid value can be obtained.
    ReplaceOriCertIsDelete Boolean Whether the original certificate is deleted when a certificate is reissued.
    Note: This field may return null, indicating that no valid value can be obtained.
    IsExpiring Boolean Whether the certificate is expiring soon. A certificate is considered to be expiring soon when there are 30 days or less left.
    Note: This field may return null, indicating that no valid value can be obtained.
    DVAuthDeadline String Validation expiration time for the addition of the DV certificate
    Note: This field may return null, indicating that no valid value can be obtained.
    ValidationPassedTime String Domain name validation pass time
    Note: This field may return null, indicating that no valid value can be obtained.
    CertSANs Array of String Multiple domain names with which the certificate is associated
    Note: This field may return null, indicating that no valid value can be obtained.
    AwaitingValidationMsg String Domain name validation rejection information
    Note: This field may return null, indicating that no valid value can be obtained.
    AllowDownload Boolean Whether downloading is allowed
    Note: This field may return null, indicating that no valid value can be obtained.
    IsDNSPODResolve Boolean
    IsPackage Boolean
    KeyPasswordCustomFlag Boolean
    SupportDownloadType SupportDownloadType

    ClbInstanceDetail

    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 The list of CLB listeners.
    Note: This field may return null, indicating that no valid values can be obtained.

    ClbInstanceList

    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 The list of CLB instances.
    Note: This field may return null, indicating that no valid values can be obtained.
    TotalCount Integer The total number of CLB instances in this region.

    ClbListener

    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 The information of the certificate bound to the listener.
    Note: This field may return null, indicating that no valid values can be obtained.
    Rules Array of ClbListenerRule The list of the listener rules.
    Note: This field may return null, indicating that no valid values can be obtained.
    NoMatchDomains Array of String The list of non-matching domains.
    Note: This field may return null, indicating that no valid values can be obtained.

    ClbListenerRule

    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 The certificates associated with the rule.
    Note: This field may return null, indicating that no valid values can be obtained.
    NoMatchDomains Array of String The list of non-matching domains.
    Note: This field may return null, indicating that no valid values can be obtained.

    DdosInstanceDetail

    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 The certificate ID.
    Note: This field may return null, indicating that no valid values can be obtained.
    VirtualPort String The forwarding port.

    DdosInstanceList

    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 The list of DDOS instances.
    Note: This field may return null, indicating that no valid values can be obtained.

    DvAuthDetail

    Content of the DvAuthDetail parameter returned by DescribeCertificates

    Used by actions: DescribeCertificate, DescribeCertificateDetail.

    Name Type Description
    DvAuthKey String DV authentication key
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthValue String DV authentication value
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthDomain String Domain name of the DV authentication value
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthPath String Path of the DV authentication value
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthKeySubDomain String DV authentication sub-domain name
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuths Array of DvAuths DV authentication information
    Note: this field may return null, indicating that no valid values can be obtained.

    DvAuths

    Content of the DvAuths parameter

    Used by actions: DescribeCertificate, DescribeCertificateDetail.

    Name Type Description
    DvAuthKey String DV authentication key
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthValue String DV authentication value
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthDomain String Domain name of the DV authentication value
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthPath String Path of the DV authentication value
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthSubDomain String DV authentication sub-domain name
    Note: this field may return null, indicating that no valid values can be obtained.
    DvAuthVerifyType String DV authentication type
    Note: this field may return null, indicating that no valid values can be obtained.

    Error

    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.

    Filter

    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.

    GatewayCertificate

    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.

    LiveInstanceDetail

    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.

    LiveInstanceList

    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.

    OperationLog

    Certificate operation logs

    Used by actions: DescribeCertificateOperateLogs.

    Name Type Description
    Action String Action performed on logs
    CreatedOn Timestamp Time when the action is performed

    PreAuditInfo

    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.

    ProjectInfo

    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.

    ResourceTypeRegions

    Cloud resource region list

    Used by actions: UpdateCertificateInstance.

    Name Type Required Description
    ResourceType String No Cloud resource type
    Regions Array of String No Region list

    RootCertificates

    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.

    SubmittedData

    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 pasted
    Note: 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.

    SupportDownloadType

    Used by actions: DescribeCertificates.

    Name Type Description
    NGINX Boolean
    APACHE Boolean
    TOMCAT Boolean
    IIS Boolean
    JKS Boolean
    OTHER Boolean
    ROOT Boolean

    SyncTaskBindResourceResult

    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.

    TCBAccessInstance

    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.

    TCBAccessService

    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.

    TCBEnvironment

    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.

    TCBEnvironments

    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.

    TCBHostInstance

    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.

    TCBHostService

    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.

    TCBInstanceList

    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.

    TSEInstanceDetail

    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.

    TSEInstanceList

    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

    Tags

    Tag

    Used by actions: DescribeCertificate, DescribeCertificateDetail, DescribeCertificates, UpdateCertificateInstance, UploadCertificate.

    Name Type Required Description
    TagKey String Yes Tag key
    TagValue String Yes Tag value

    TeoInstanceDetail

    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 The status of the domain.

    TeoInstanceList

    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.

    TkeIngressDetail

    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.

    TkeInstanceDetail

    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.

    TkeInstanceList

    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.

    TkeNameSpaceDetail

    Details of a TKE namespace

    Used by actions: DescribeCertificateBindResourceTaskDetail.

    Name Type Description
    Name String The namespace name.
    SecretList Array of TkeSecretDetail The secret list.

    TkeSecretDetail

    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.

    UpdateRecordDetail

    Update record details

    Used by actions: DescribeHostUpdateRecordDetail.

    Name Type Description
    Id Integer Detail record ID
    CertId String New certificate ID
    OldCertId String 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 Deployment resource type
    Region String Deployment region
    Note: This field may return null, indicating that no valid value can be obtained.
    Status Integer Deployment status
    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.

    UpdateRecordDetails

    Update record detail list

    Used by actions: DescribeHostUpdateRecordDetail.

    Name Type Description
    ResourceType String Deployment resource type
    List Array of UpdateRecordDetail Deployment resource detail list
    TotalCount Integer Total deployment resource count

    UpdateRecordInfo

    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

    UpdateSyncProgress

    Used by actions: UpdateCertificateInstance.

    Name Type Description
    ResourceType String
    UpdateSyncProgressRegions Array of UpdateSyncProgressRegion
    Status Integer

    UpdateSyncProgressRegion

    Used by actions: UpdateCertificateInstance.

    Name Type Description
    Region String
    TotalCount Integer
    OffsetCount Integer
    Status Integer

    VODInstanceList

    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.

    VodInstanceDetail

    Details of a VOD instance

    Used by actions: DescribeCertificateBindResourceTaskDetail.

    Name Type Description
    Domain String The domain.
    CertId String The certificate ID.

    WafInstanceDetail

    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.

    WafInstanceList

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy