tencent cloud

APIs

DocumentationAPIsCloud Log ServiceOpenClaw APIsOpenClawService

OpenClawService

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

1. API Description

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

This API is used to create resources and indexes dependent on OpenClaw.

A maximum of 200 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: OpenClawService.
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.
Tag Yes String

Tag type

Enumeration value:

  • OpenClaw: OpenClaw type
  • ClawPro: ClawPro type
EnableTrace No Boolean

Whether to create a trace topic, default to false

Enumeration value:

  • true: Creates a trace topic
  • false: Does not create a trace topic

3. Output Parameters

Parameter Name Type Description
LogsetId String

Logset id

Logset document
LogsetName String

Logset name
TopicId String

Log topic id

Log topic document
TopicName String

Log topic name
MetricTopicId String

Metric topic id

Metric topic document
MetricTopicName String

Metric topic name
MachineGroupId String

Bound machine group id

Machine group document
MachineGroupName String

Machine group name
AppLogConfigId String

Collection configuration id. Application log

Collection overview document - LogListener collection configuration import
AppLogConfigName String

Collection configuration name. Application log
SessionLogConfigId String

Collection configuration id. Session log

Collection overview document - LogListener collection configuration import
SessionLogConfigName String

Collection configuration name. Session log
TraceTopicId String

trace topic ID
TraceTopicName String

trace topic name
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 Creating OpenClawService Log Service

Input Example

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

{
    "Tag": "ClawPro"
}

Output Example

{
    "Response": {
        "AppLogConfigId": "b1ba2eba-8d9f-4091-a6a8-820ac2b2d85c",
        "AppLogConfigName": "clawpro_app_log_collect",
        "LogsetId": "claw-logset-ap-guangzhou-open-1254139626",
        "LogsetName": "claw_logset",
        "MachineGroupId": "da7b700c-2d4b-475b-b8a1-d2ecfbe3df81",
        "MachineGroupName": "ClawPro_MachineGroup",
        "MetricTopicId": "clawpro-metric-topic-ap-guangzhou-open-1254139626",
        "MetricTopicName": "clawpro_metric_topic",
        "SessionLogConfigId": "39134e29-ed4d-4299-9929-2fa94a060838",
        "SessionLogConfigName": "clawpro_session_log_collect",
        "TopicId": "clawpro-topic-ap-guangzhou-open-1254139626",
        "TopicName": "clawpro_log_topic",
        "RequestId": "ca5966ab-6fa6-4cdb-bdf7-695b551c005b"
    }
}

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.
FailedOperation.InValidIndexRuleForSearchLow IA storage does not support key-value or tag index configuration.
FailedOperation.Timeout Operation timed out
FailedOperation.TopicIsolated The log topic has been isolated.
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameter.InValidIndexRuleForSearchLow IA storage does not support key-value or tag index configuration.
InvalidParameter.IndexConflict An index rule already exists for the specified log topic.
LimitExceeded The quota limit has been reached.
LimitExceeded.IndexKeyOverLimit The number of key-value indices exceeds the limit
LimitExceeded.IndexOperating Index operations exceed the frequency limit.
MissingParameter Missing parameter.
OperationDenied Operation denied.
OperationDenied.AccountDestroy The account has been terminated.
OperationDenied.AccountIsolate The account has overdue payments.
OperationDenied.AccountNotExists The account does not exist.
ResourceNotFound.IndexNotExist The index does not exist.
ResourceNotFound.TopicNotExist The log topic does not exist.
UnsupportedOperation Unsupported operation.
Previous Topic: ModifyNetworkApplicationNext Topic: ModifySearchView

Help and Support

Was this page helpful?

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

Feedback