Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to modify a RemoteWrite task.
A maximum of 20 requests can be initiated per second for this API.
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: ModifyRemoteWriteTask. |
| 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 |
| Enable | No | Integer | Task status. 0: disabled, 1: enabled. |
| Name | No | String | RemoteWrite task name. |
| NetType | No | Integer | Valid values: 1: private network; 2: public network. |
| VpcId | No | String | VPC id |
| Target | No | String | Target service name. |
| RemoteWriteURL | No | String | Destination address |
| AuthType | No | Integer | Valid values: 0: no authentication; 1: basic_auth; 2: token. |
| AuthInfo | No | RemoteWriteAuthInfo | Authentication information |
| VirtualGatewayType | No | Integer | Backend service type -1 No 0 CVM 1025 CLB |
| 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. |
Modifying the Details of a RemoteWrite Task
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyRemoteWriteTask
<Common request parameters>
{
"TaskId": "xxx-xxx-xxx-xxx",
"TopicId": "xxx-xxx-xxx-xxx",
"Enable": 0,
"Name": "test",
"NetType": 1,
"VpcId": "cls-xxxx",
"Target": "Prometheus",
"RemoteWriteURL": "http://127.0.0.1:80/api/v1/write",
"AuthType": 1,
"AuthInfo": {
"Username": "test",
"Password": "passwrod",
"Token": ""
}
}
{
"Response": {
"RequestId": "xxx-xxx-xxx-xxx"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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 | Incorrect parameter. |
| InvalidParameter.DbDuplication | The unique key of database conflicts. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
| ResourceNotFound.TopicNotExist | The log topic does not exist. |
フィードバック