Docs Overview/
DescribeSecurityClientAttester/

DescribeSecurityClientAttester

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to query client authentication option configuration.

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 NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: DescribeSecurityClientAttester.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringZone ID.
LimitNoIntegerPaginated query limit. default value: 20, maximum value: 100.
OffsetNoIntegerThe offset of paginated query. Default value: 0.

3. Output Parameters

Parameter NameTypeDescription
TotalCountIntegerTotal number of authentication options.
ClientAttestersArray of ClientAttesterSpecifies the authentication option list.
RequestIdStringThe 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 Querying Client Authentication Option Configuration for Specified Site

This example shows you how to paginate client authentication option configuration for a specified site.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeSecurityClientAttester
<Common request parameters>

{
    "ZoneId": "zone-123123232",
    "Limit": 10,
    "Offset": 0
}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "ClientAttesters": [
            {
                "Name": "test1",
                "Id": "attest-2180001023",
                "AttesterSource": "TC-RCE",
                "Type": "CUSTOM",
                "AttesterDuration": "300s",
                "TCRCEOption": {
                    "Channel": "12399223"
                }
            }
        ],
        "RequestId": "ddf831fc-cf45-40fe-81b0-2d9cdd4c1bd6"
    }
}

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

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.