tencent cloud

APIs

DocumentationAPIsCloud Log ServiceSplunk Delivery APIsModifySplunkDeliver

ModifySplunkDeliver

Download
Focus Mode
Font Size
Last updated: 2026-06-10 15:00:24

1. API Description

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

Modify information related to splunk delivery task

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: ModifySplunkDeliver.
Version Yes String Common Params. The value used for this API: 2020-10-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
TaskId Yes String

Task ID.
TopicId Yes String

log topic id
Name No String

The delivery task name has the following restrictions: - Cannot be empty - Length not greater than 256 - Can only contain aA-zZ, underscore, -, 0-9
Enable No Integer

Task enable status. Valid values: 0: disabled; 1: enabled.
NetInfo No NetInfo

splunk delivery task - target configuration
MetadataInfo No MetadataInfo

splunk delivery task meta information
HasServiceLog No Integer

Whether to enable the service log; 1: Disabled; 2: Enabled
IndexAck No Integer

Advanced configuration - Whether to enable the indexer;
1 - Disable; 2 - Enable; Default: 1
Source No String

Advanced configuration - data source; no more than 64 characters
SourceType No String

Advanced configuration - data source type; no more than 64 characters
Index No String

Advanced configuration - Indexes written to Splunk; no more than 64 characters
Channel No String

Advanced configuration - Channel.
To meet the limitation: If the indexer is enabled, the value cannot be empty.
DSLFilter No String

Pre-filtering process - filter out original data before writing to Splunk
ExternalRole No ExternalRole

Advanced configuration - Cross-account delivery user role authorization information

For reference: Create custom role

3. Output Parameters

Parameter Name Type Description
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 Modifying a Splunk Delivery Task

Input Example

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

{
    "TaskId": "65a07eec-96ee-458d-850b-53dfe9b43125",
    "TopicId": "d1d7d473-827e-4dad-9a42-f0287ad43125",
    "MetadataInfo": {
        "Format": "json",
        "MetaFields": [
            "__SOURCE__"
        ]
    }
}

Output Example

{
    "Response": {
        "RequestId": "89b26245-ec3e-4b00-829a-bcc835d43125"
    }
}

Example2 Modifying Splunk Delivery Task - Cross-Account Delivery Task

Input Example

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

{
    "TaskId": "565a2f82-22d3-4f2e-b417-0e251805c63a",
    "TopicId": "6b81282d-f355-404f-ae1f-6e00b27dfc70",
    "ExternalRole": {
        "RoleArn": "qcs::cam::uin/1000011275:roleName/splunk",
        "ExternalId": "splunk"
    }
}

Output Example

{
    "Response": {
        "RequestId": "7f4f486d-00f6-4cad-b212-37b789d78d45"
    }
}

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
AuthFailure CAM signature/authentication error.
AuthFailure.UnauthorizedOperation Request unauthorized.
FailedOperation Operation failed.
FailedOperation.Timeout Operation timed out
InternalError Internal error.
InternalError.DbError DB Error.
InternalError.IllegalRole Illegal role.
InvalidParameter Incorrect parameter.
InvalidParameter.ParamError Parameter error.
InvalidParameterValue Incorrect parameter value.
LimitExceeded.RecordOutOfLimit Record exceeds limit
MissingParameter Missing parameter.
UnauthorizedOperation Unauthorized operation.
UnknownParameter Unknown parameter error.
UnsupportedOperation Unsupported operation.
Previous Topic: DescribeSplunkPreviewNext Topic: DescribeNetworkApplications

Help and Support

Was this page helpful?

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

Feedback