tencent cloud

APIs

DescribeAgentConfigSetting

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:35:59

1. API Description

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

Query client configuration settings (configuration group). This is a standalone API split from DescribeAgentRunMode.

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: DescribeAgentConfigSetting.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
MemberId.N No Array of String

Group account member id

3. Output Parameters

Parameter Name Type Description
EnhanceLogMode Integer

Enhancement log mode switch. 0: turn off; 1: turn on (empty if not configured)

MalwarePocMode Integer

Malware POC mode switch. 0: Turn off. 1: Turn on. (Empty if not configured)

ReportSourcePort Integer

Report source port switch (compatible with old versions). 0: off, 1: on

LogCollectSettings Array of String

List of enabled log collection types, for example, tcp_ingress, tcp_src_port, http_egress, http_ingress, app_access

AssetSelectionType String

Asset selection method: all/tag/direct

TagIds Array of String

Tag ID array used when selecting by tag

InstanceIDs Array of String

direct selection of the host instance_id list

ExcludeInstanceIDs Array of String

Exclusion instance_id list of the host

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 Querying

Input Example

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

{
    "MemberId": [
        "mem-tencent-b624e485fee5fe29"
    ]
}

Output Example

{
    "Response": {
        "AssetSelectionType": "direct",
        "EnhanceLogMode": 0,
        "ExcludeInstanceIDs": [],
        "InstanceIDs": [
            "ins-q4pf14qs"
        ],
        "LogCollectSettings": [
            "tcp_ingress"
        ],
        "MalwarePocMode": 0,
        "ReportSourcePort": 0,
        "TagIds": [],
        "RequestId": "82adab1d-9b89-4620-97f5-288d69e1bdaa"
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameterValue Parameter value error.
MissingParameter Parameters are missing.
OperationDenied Operation denied.
ResourceNotFound The resource does not exist.

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback