tencent cloud

APIs

DocumentaçãoAPIsCloud Log ServiceMetric Collection Configuration APIsModifyHostMetricConfig

ModifyHostMetricConfig

Baixar
Modo Foco
Tamanho da Fonte
Última atualização: 2026-06-10 15:00:56

1. API Description

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

Modify host metric collection 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 Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyHostMetricConfig.
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.
TopicId Yes String Metric Topic id
- Get the log topic Id through Get Log Topic List. Note: BizType 0: log topic (default value), 1: metric topic.
- Obtain the log topic Id through Create Log Topic. Note that BizType 0: log topic (default value), 1: metric topic.
ConfigId Yes String Collection configuration ID.
Name No String Name

-Length not exceeding 64 characters.
MachineGroupIds.N No Array of String Machine group id list. Supports up to 100 machine groups.
Interval No Integer Collection frequency. Unit: ms. Minimum support 5000 ms.
HostMetricItems.N No Array of HostMetricItem Collection items. Support "cpu", "mem", "net", "disk", "system". Currently only support: ALL collection items require configuration.
- cpu:CPU
-mem: memory
-net: Network
-disk
-system

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 Modify Host Monitoring Collection Configuration

Input Example

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

{
    "TopicId": "46c21ba9-b6ea-45f1-8710-5ad92b978b7a",
    "ConfigId": "b64d4365-0d37-4db0-a603-1412e8bb747c",
    "Name": "metric_config_update",
    "Interval": 35000
}

Output Example

{
    "Response": {
        "RequestId": "12b800c1-123c-4148-8d16-bc816dc71ecc"
    }
}

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.DbDuplication The unique key of database conflicts.
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.
Anterior: DeleteHostMetricConfigPróximo: DeleteMetricConfig

Ajuda e Suporte

Esta página foi útil?

comentários