tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Web Application Firewall
    Documentation
    Download PDF

    DescribeSpartaProtectionInfo

    Last updated: 2024-09-25 10:12:40
    Download PDF

    1. API Description

    Domain name for API request: waf.tencentcloudapi.com.

    WAF Sparta - Obtain protection domain information

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: DescribeSpartaProtectionInfo.
    Version Yes String Common Params. The value used for this API: 2018-01-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-guangzhou, ap-seoul, ap-singapore.
    Domain Yes String Domain name
    Edition No String Version
    InstanceID No String Instance

    3. Output Parameters

    Parameter Name Type Description
    Domain String Domain name
    DomainId String Domain ID
    Cname String CNAME value
    Status String Status
    SrcList Array of String Source IP address list
    CertType String Certificate type
    Cert String Certificate
    PrivateKey String Private key
    Sslid String SSL ID
    IsCdn String Whether it is a CDN
    GrayAreas Array of String Grayscale area list
    Engine String Engine
    HttpsRewrite String HTTPS rewriting
    UpstreamType String upstreamType value
    UpstreamDomain String Value of upstreamDomain
    UpstreamScheme String Value of upstreamScheme
    IsHttp2 String Whether it is HTTP2.
    IsWebsocket String Whether it includes WebSocket
    LoadBalance String LoadBalance information
    HttpsUpstreamPort String Value of httpsUpstreamPort
    Ports Array of PortItem Port information
    IsGray String Whether it is grayscale
    Mode String Mode
    Level String Defense level: 100, 200, 300
    IsKeepAlive String Whether to maintain a long connection with the origin server
    Anycast String 0: BGP; 1: Anycast.
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 WAF Sparta - Obtain protection domain information

    Input Example

    https://waf.tencentcloudapi.com/?Action=DescribeSpartaProtectionInfo
&Domain=www.test1.com
&Edition=sprata-waf
&<Common request parameters>

    Output Example

    {
    "Response": {
        "Cert": "test",
        "CertType": "1",
        "Cname": "",
        "Domain": "www.test1.com",
        "DomainId": "",
        "Engine": "1",
        "GrayAreas": [
            "n"
        ],
        "HttpsRewrite": "0",
        "HttpsUpstreamPort": "0",
        "IsCdn": "0",
        "IsGray": "0",
        "IsHttp2": "0",
        "IsWebsocket": "0",
        "LoadBalance": "0",
        "Mode": "1",
        "Ports": [],
        "PrivateKey": "xxxx",
        "RequestId": "1548ac10-3e48-4cee-b71b-fc1071421761",
        "SrcList": [
            "1.1.1."
        ],
        "Sslid": "",
        "Status": "2",
        "UpstreamDomain": "",
        "UpstreamScheme": "http",
        "UpstreamType": "0",
        "Level": "200",
        "IsKeepAlive": "1",
        "Anycast": "1"
    }
}

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy