1. Interface Description
Interface request domain name: monitor.api3.convergecloud.com.
Pulls CLS log topics.
Default interface request rate limit: 20 times per second.
Interface update time: 2022-08-27 22:31:17.
The interface only verifies the signature but does not authenticate.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: DescribeLogTopics |
| Version | Yes | No | String | Public parameter, The value of this interface: 2018-07-24 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| LogSetId | Yes | No | String | Log set ID. Example: d5f10b84-def8-4e58-bab0-16ef567b1f22 |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| Data | String | Result data in JSON. Example: {"topics":[{"collection":true,"create_time":"2019-10-22 13:55:09","extract_rule":{"beginning_regex":"(\\S+)\\s\\S+\\s(\\S+)\\s\\[([^\\]]+)\\]\\s\\\"([^\\\"]+)\\s(\\S+)\\s([^\\\"]+)\\\"\\s(\\d+)\\s(\\d+)\\s\\\"([^\\\"]+)\\\"\\s\\\"([^\\\"]+)\\\"\\s\\\"([^\\\"]+)\\\"$","filter_keys":[],"filter_regex":[],"keys":["remote_addr","remote_user","time_local","http_method","http_uri","http_protocol","http_status","body_bytes_sent","http_referer","http_user_agent","http_x_forwarded_for"],"log_regex":"(\\S+)\\s\\S+\\s(\\S+)\\s\\[([^\\]]+)\\]\\s\\\"([^\\\"]+)\\s(\\S+)\\s([^\\\"]+)\\\"\\s(\\d+)\\s(\\d+)\\s\\\"([^\\\"]+)\\\"\\s\\\"([^\\\"]+)\\\"\\s\\\"([^\\\"]+)\\\"$"},"index":true,"log_type":"fullregex_log","logset_id":"d5f10b84-def8-4e58-bab0-16ef567b1f33","partition_count":1,"path":"","shipper":false,"sql_flag":false,"topic_id":"d4253323-7dfc-4b1b-8889-d82cef77375b","topic_name":"cms-nginx-regex","wild_path":"/data/log/nginx/**/default.log"}]} |
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| FailedOperation | Operation failed. |
| MissingParameter | Missing parameter. |
| UnauthorizedOperation | Unauthorized operation. |
| FailedOperation | Operation failed. |
| UnsupportedOperation | Unsupported operation. |