This API is used to create a log group. All API URLs described in this section must be case-sensitive.
-Function
This function describes how to create a log group for log storage and query. You can create a maximum of 100 log groups.
+This API is used to create a log group. All API URLs described in this section must be case-sensitive.
+Function
This function describes how to create a log group for log storage and query. You can create a maximum of 100 log groups.
URI
- URI format
POST /v2.0/{project_id}/log-groups
+URI
-- Parameter description
-
Table 1 Parameter description Parameter
+- Parameter description
+
Table 1 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID
+Project ID
Request
- Request parameters
-
Table 2 Parameter description Parameter
+-Request
- Request parameters
+
Table 2 Parameter description Parameter
Sub-Parameter
+Sub-Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
log_group_name
+log_group_name
N/A
+N/A
Yes
+Yes
String
+String
Log group name.
-The configuration rules are as follows:
-- Must be a string of 1 to 64 characters.
- Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. The name cannot start or end with a period.
Log group name.
+The configuration rules are as follows:
+- Must be a string of 1 to 64 characters.
- Only allows uppercase and lowercase letters, digits, underscores (_), hyphens (-), and periods (.). The name cannot start with a period or underscore, or end with a period.
ttl_in_days
+ttl_in_days
N/A
+N/A
Yes
+Yes
Int
+Int
Log expiration time. The value is fixed to 7 days.
+Log retention duration. (default: 30 days)
+Minimum value: 1
+Maximum value: 365
- Example request
POST /v2.0/{project_id}/log-groups +- Example request
POST /v2.0/{project_id}/log-groups { "log_group_name":"test01", "ttl_in_days": 7 }
- Example request
Response
- Response parameters
-
Table 3 Parameter description Parameter
+-Response
- Response parameters
+
Table 3 Parameter description Parameter
Sub-Parameter
+Sub-Parameter
Type
+Type
Description
+Description
log_group_id
+log_group_id
N/A
+N/A
String
+String
Log group ID
+Log group ID
- Example response
{ +- Example response
{ "log_group_id":"56b4b31f-3024-11e9-9023-286ed488ce71" }
- Example response
diff --git a/docs/lts/api-ref/lts_02_0004.html b/docs/lts/api-ref/lts_02_0004.html index c80377933..97ff1cdf3 100644 --- a/docs/lts/api-ref/lts_02_0004.html +++ b/docs/lts/api-ref/lts_02_0004.html @@ -1,37 +1,37 @@Returned Value
- Normal
+
Returned Value
-- Abnormal
For details about status code, see Status Code.
+- Abnormal
For details, see Status Codes.
- Abnormal
- Abnormal
Querying a Log Group
-Function
This function describes how to query a log group you have created to obtain its name, ID, expiration time, and creation time.
+-Function
This function describes how to query a log group you have created to obtain its name, ID, expiration time, and creation time.
URI
- URI format
GET /v2.0/{project_id}/log-groups/{group_id}
+URI
-- Parameter description
-
Table 1 Parameter description Parameter
+- Parameter description
+
Table 1 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID
+Project ID
group_id
+group_id
Yes
+Yes
String
+String
Log group ID
+Log group ID
Request
- Request parameters -
- Example request
GET /v2.0/{project_id}/log-groups/{group_id}+ -Response
- Response parameters
-
Table 2 Parameter description Parameter
+-Response
- Response parameters
+-
Table 2 Parameter description Parameter
Sub-Parameter
+Sub-Parameter
Type
+Type
Description
+Description
log_group_id
+log_group_id
-
+-
String
+String
Log group ID
+Log group ID
log_group_name
+log_group_name
-
+-
String
+String
Log group name
+Log group name
creation_time
+creation_time
-
+-
Int64
+Int64
Log group creation time
+Log group creation time
ttl_in_days
+ttl_in_days
-
+-
Int
+Int
Log expiration time
+Log expiration time
+stream_size
+-
+Int
+Number of log streams in a log group
- Example response
{ + - Example response
{ "log_group_id": "8ac95c07-357b-11e9-bc2a-286ed488ce71", "log_group_name": "lts-group-3h0y", "creation_time": 1550714033721, + "stream_size ": 0, "ttl_in_days": 7 }
diff --git a/docs/lts/api-ref/lts_02_0005.html b/docs/lts/api-ref/lts_02_0005.html index 3d6c18933..7c7d22788 100644 --- a/docs/lts/api-ref/lts_02_0005.html +++ b/docs/lts/api-ref/lts_02_0005.html @@ -1,39 +1,39 @@Returned Value
- Normal -
- Abnormal
For details, see Status Code.
+Returned Value
- Normal +
- Abnormal
For details, see Status Codes.
Deleting a Log Group
-Function
This function describes how to delete a log group that will not be used.
-
Before deleting a log group, ensure that the log group has no log transfer tasks. Deleted log groups cannot be recovered. Therefore, exercise caution when performing this deletion operation.
+-Function
This function describes how to delete a log group that will not be used.
+ Before deleting a log group, ensure that the log group has no log transfer tasks. Deleted log groups cannot be recovered. Therefore, exercise caution when performing this deletion operation.
URI
- URI format
DELETE /v2.0/{project_id}/log-groups/{group_id}
+URI
-- Parameter description
-
Table 1 Parameter description Parameter
+- Parameter description
+
Table 1 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID
+Project ID
group_id
+group_id
Yes
+Yes
String
+String
ID of a created log group
+ID of a created log group
Request
- Request parameters -
- Example request
DELETE /v2.0/{project_id}/log-groups/{group_id}+ -Response
- Response parameters -
- Example response
+
-diff --git a/docs/lts/api-ref/lts_02_0006.html b/docs/lts/api-ref/lts_02_0006.html index bdae73888..5d3b32186 100644 --- a/docs/lts/api-ref/lts_02_0006.html +++ b/docs/lts/api-ref/lts_02_0006.html @@ -1,7 +1,7 @@
Returned Value
- Normal -
- Abnormal
For details about status code, see Status Code.
+Returned Value
- Normal +
- Abnormal
For details, see Status Codes.
Log Stream Management (Old Version)
- +diff --git a/docs/lts/api-ref/lts_02_0007.html b/docs/lts/api-ref/lts_02_0007.html index e7cbb0413..cb4f88d11 100644 --- a/docs/lts/api-ref/lts_02_0007.html +++ b/docs/lts/api-ref/lts_02_0007.html @@ -1,37 +1,37 @@- Creating a Log Stream
@@ -11,5 +11,9 @@ - Deleting a log stream
+Parent topic: APIs+Creating a Log Stream
-Function
This function describes how to create a log stream under a created log group. You can view and query raw logs under a log stream.
+-Function
This function describes how to create a log stream under a created log group. You can view and query raw logs under a log stream.
URI
- URI format
POST /v2.0/{project_id}/log-groups/{group_id}/log-topics
+URI
-- Parameter description
-
Table 1 Parameter description Parameter
+- Parameter description
+
Table 1 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID
+Project ID
group_id
+group_id
Yes
+Yes
String
+String
ID of a created log group
+ID of a created log group
Request
- Request parameters
-
Table 2 Parameter description Parameter
+-Request
- Request parameters
+
Table 2 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
log_topic_name
+log_topic_name
Yes
+Yes
String
+String
Log stream name.
-The configuration rules are as follows:
-- Must be a string of 1 to 64 characters.
- Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. The name cannot start or end with a period.
Log stream name.
+The configuration rules are as follows:
+- Must be a string of 1 to 64 characters.
- Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. The name cannot start or end with a period.
- Example request
POST +
- Example request
POST /v2.0/{project_id}/log-groups/{group_id}/log-topics { "log_topic_name":"testTopic01" }
- Example request
Response
- Response parameters
-
Table 3 Parameter description Parameter
+-Response
- Response parameters
+
Table 3 Parameter description Parameter
Type
+Type
Description
+Description
log_topic_id
+log_topic_id
String
+String
ID of a log stream
+ID of a log stream
- Example response
{ +- Example response
{ "log_topic_id":"a25d64c8-3028-11e9-9660-286ed488ce71" }
- Example response
diff --git a/docs/lts/api-ref/lts_02_0008.html b/docs/lts/api-ref/lts_02_0008.html index 5fe006812..a2e68e764 100644 --- a/docs/lts/api-ref/lts_02_0008.html +++ b/docs/lts/api-ref/lts_02_0008.html @@ -1,46 +1,46 @@Returned Value
- Normal -
- Abnormal
For details about status code, see Status Code.
+Returned Value
- Normal +
- Abnormal
For details, see Status Codes.
Querying a Log Stream
-Function
This function describes how to query a log stream you have created to obtain its name, ID, expiration time, and creation time.
+-Function
This function describes how to query a log stream you have created to obtain its name, ID, expiration time, and creation time.
URI
- URI format
GET /v2.0/{project_id}/log-groups/{group_id}/log-topics/{topic_id}
+URI
-- Parameter description
-
Table 1 Parameter description Parameter
+- Parameter description
+
Table 1 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID
+Project ID
group_id
+group_id
Yes
+Yes
String
+String
Log group ID
+Log group ID
topic_id
+topic_id
Yes
+Yes
String
+String
ID of a log stream
+ID of a log stream
Request
- Request parameters -
- Example request
GET /v2.0/{project_id}/log-groups/{group_id}/log-topics/{topic_id}+-Request
Response
- Response parameters
-
Table 2 Parameter description Parameter
+-Response
- Response parameters
+-
Table 2 Parameter description Parameter
Sub-Parameter
+Sub-Parameter
Type
+Type
Description
+Description
log_topic_name
+log_topic_name
-
+-
String
+String
Log stream name
+Log stream name
creation_time
+creation_time
-
+-
Int64
+Int64
Log group creation time
+Log group creation time
index_enabled
+index_enabled
-
+-
Bool
+Bool
Search switch
+Search switch
- Example response
{ + - Example response
{ "log_topic_name": "lts-topic-jgpv", "creation_time": 1550803822973, "index_enabled": true }
diff --git a/docs/lts/api-ref/lts_02_0009.html b/docs/lts/api-ref/lts_02_0009.html index c714e2106..84973a77e 100644 --- a/docs/lts/api-ref/lts_02_0009.html +++ b/docs/lts/api-ref/lts_02_0009.html @@ -1,48 +1,48 @@Returned Value
- Normal -
- Abnormal
For details, see Status Code.
+Returned Value
- Normal +
- Abnormal
For details, see Status Codes.
Deleting a log stream
-Function
This function describes how to delete a log stream that will not be used.
- Before deleting a log stream, ensure that the log stream has no log transfer tasks. Deleted log streams cannot be recovered. Therefore, exercise caution when performing this deletion operation.
+-Function
This function describes how to delete a log stream that will not be used.
+ Before deleting a log stream, ensure that the log stream has no log transfer tasks. Deleted log streams cannot be recovered. Therefore, exercise caution when performing this deletion operation.
URI
- URI format
DELETE /v2.0/{project_id}/log-groups/{group_id}/log-topics/{topic_id}
+URI
-- Parameter description
-
Table 1 Parameter description Parameter
+- Parameter description
+
Table 1 Parameter description Parameter
Mandatory
+Mandatory
Type
+Type
Description
+Description
project_id
+project_id
Yes
+Yes
String
+String
Project ID
+Project ID
group_id
+group_id
Yes
+Yes
String
+String
ID of a created log group
+ID of a created log group
topic_id
+topic_id
Yes
+Yes
String
+String
ID of a created log stream
+ID of a created log stream
Request
- Request parameters -
- Example request
DELETE /v2.0/{project_id}/log-groups/{group_id}/log-topics/{topic_id}+-Request
Response
- Parameter description -
- Example response
+
-diff --git a/docs/lts/api-ref/lts_02_0014.html b/docs/lts/api-ref/lts_02_0014.html deleted file mode 100644 index e48af53f6..000000000 --- a/docs/lts/api-ref/lts_02_0014.html +++ /dev/null @@ -1,43 +0,0 @@ - - -
Returned Value
- Normal -
- Abnormal
For details about status code, see Status Code.
+Returned Value
- Normal +
- Abnormal
For details, see Status Codes.
Change History
--- diff --git a/docs/lts/api-ref/lts_02_0019.html b/docs/lts/api-ref/lts_02_0019.html deleted file mode 100644 index ca7e40d61..000000000 --- a/docs/lts/api-ref/lts_02_0019.html +++ /dev/null @@ -1,15 +0,0 @@ - - --
-Released On
-Description
-2022-10-30
-Modified as follows:
-- Added section Log Group Management (New Version).
- Added section Log Stream Management (New Version).
- Added section Log Management.
- Added section Log Transfer.
2022-09-22
-Modified as follows:
-Added the restriction description of request parameter ttl_in_days in Creating a Log Group.
-2019-04-26
-Modified as follows:
-A maximum of 100 log groups and 100 log streams are supported.
-2019-04-19
-- Changed the Endpoint URL of LTS from https://Endpoint/uri to https://lts.eu-de.otc.t-systems.com/uri.
- Changed Ttl_in_days to ttl_in_days in the response parameter description table in Querying a Log Group.
- Deleted the log_topics parameter in the response parameter description table in Querying a Log Stream.
2019-03-30
-This issue is the first official release.
-Public Parameters
- -- -- diff --git a/docs/lts/api-ref/lts_02_0020.html b/docs/lts/api-ref/lts_02_0020.html deleted file mode 100644 index 0ea35c739..000000000 --- a/docs/lts/api-ref/lts_02_0020.html +++ /dev/null @@ -1,100 +0,0 @@ - - -Status Code
--Table 1 lists the status code.
- --
-Table 1 Status code description Status Code
-Returned Value
-Description
-200
-OK
-The results of GET and PUT operations are returned normally.
-201
-OK
-The POST request is successful and the query result is returned.
-204
-No Content
-The result of the DELETE operation is returned normally.
-400
-Bad Request
-Request error.
-401
-Unauthorized
-The authentication information is not provided or is incorrect.
-403
-Forbidden
-You are forbidden to access the requested page.
-404
-Not Found
-The server failed to find the requested resource.
-408
-Request Timeout
-The request timed out.
-429
-Too Many Requests
-The number of requests exceeds the upper limit.
-500
-Internal Server Error
-Failed to complete the request because of a service error.
-503
-Service Unavailable
-Failed to complete the request because the system is unavailable.
--- diff --git a/docs/lts/api-ref/lts_02_0021.html b/docs/lts/api-ref/lts_02_0021.html deleted file mode 100644 index c6a99a1da..000000000 --- a/docs/lts/api-ref/lts_02_0021.html +++ /dev/null @@ -1,199 +0,0 @@ - - ---Parent topic: Public Parameters-Error Code
---Description
This section explains the meanings of error code responses returned by LTS APIs.
--Response Format
{"error_msg":"Current user is not authenticated correctly, check your token.","error_code":"LTS.0002"}
--Error Code Description
--
-Table 1 Error code description Response Code
-Error Code
-Description
-Error Message
-Handling Measure
-400
-LTS.0101
- -Failed to create the log group because a log group with the same name already exists.
-Failed to create log group, the group name has been existed
-Check the log group name.
-400
-LTS.0104
- -Failed to create the log group because the maximum number of log groups has been reached.
-Failed to create log group, the number of log groups exceeds the quota
-Check whether the number of log groups reaches the quota (100 by default).
-400
-LTS.0105
-Failed to delete the log group because the log group has associated log transfer tasks.
-Log group is associated by transfer
-Check whether the associated log transfer tasks have been deleted.
-404
-LTS.0201
-Failed to create a log stream because the associated log group does not exist.
-The group is not existed
-Check the ID of the log group.
-400
-LTS.0205
-Failed to create a log stream because the log stream name already exists.
-The topic name has been existed
-Check whether the log stream with the same name already exists.
-400
-LTS.0206
-Failed to create a log stream because the maximum number of log streams has been reached.
-Failed to create log topic, the number of log topics exceeds the quota
-Check whether the number of log streams reaches the quota (100 by default).
-400
-LTS.0207
-Failed to delete the log stream because the log stream has associated a log transfer task.
-Log topic is associated by transfer
-Check whether the associated log transfer task has been deleted.
-500
-LTS.0010
- -System internal error.
-The system encountered an internal error
-Contact the administrator.
-500
-LTS.0102
-Failed to create the log group.
-Failed to create log group.
-Check whether the project ID is correct and whether the log group name meets the requirements.
-500
-LTS.0103
-Failed to delete the log group.
-Failed to delete log group
-Check whether the database is normal or whether the network connection is normal.
-500
-LTS.0202
-Failed to create a log stream.
-Failed to create log topic
-Check whether the project and group IDs are correct and whether the log stream name meets the requirements.
-500
-LTS.0203
-Failed to delete the log stream.
-Failed to delete log topic
-Check whether the database is normal or whether the network connection is normal.
-400
-LTS.0001
-The API version /projectId is invalid or does not exist.
-API version/project id invalid or missing
-Check whether the version and projectID information is correct.
-401
-LTS.0002
-Unauthorized user token.
-Current user is not authenticated correctly, check your token
-Check the token information of the current user.
-400
-LTS.0011
-Invalid resource ID.
-The resource id is invalid or missing
-Check whether the resource ID in the request is correct.
--- diff --git a/docs/lts/api-ref/lts_api_0000.html b/docs/lts/api-ref/lts_api_0000.html new file mode 100644 index 000000000..423338157 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0000.html @@ -0,0 +1,8 @@ + + +--Parent topic: Public Parameters-API Description
++ diff --git a/docs/lts/api-ref/lts_api_0002.html b/docs/lts/api-ref/lts_api_0002.html new file mode 100644 index 000000000..8f9ff2fa8 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0002.html @@ -0,0 +1,88 @@ + + +Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://lts.eu-de.otc.t-systems.com/uri. In the URL, uri indicates the resource path, that is, the API access path.
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by Application/json.
+For details about how to use APIs, see API Usage Guidelines.
+API Overview
++ + diff --git a/docs/lts/api-ref/lts_api_0003.html b/docs/lts/api-ref/lts_api_0003.html new file mode 100644 index 000000000..752559e1d --- /dev/null +++ b/docs/lts/api-ref/lts_api_0003.html @@ -0,0 +1,15 @@ + + +LTS extension APIs allow you to use the basic LTS functions. For example, you can query API versions, create, query, and delete log groups or log streams.
+Table 1 describes the LTS APIs.
+ ++
+Table 1 API description Category
+Description
+Log group management (old version)
+APIs for creating, querying, and deleting log groups
+Log stream management (old version)
+APIs for creating, querying, and deleting log streams
+Host group management
+APIs for creating, querying, deleting, and modifying host groups
+Log group management
+APIs for creating, querying, deleting, and modifying log groups
+Log stream management
+APIs for creating, querying, deleting, and modifying log streams
+Log management
+APIs for querying logs
+Log ingestion
+APIs for reporting logs
+Log transfer
+APIs for transferring logs of one or more specified log streams to other services
+Log collection beyond free quota
+APIs for enabling or disabling log collection beyond free quota
+Cloud structuring
+APIs for structuring logs, and querying, modifying, and deleting structuring rules
+Keyword alarm rules
+APIs for creating, querying, modifying, and deleting keyword alarm rules
+Alarm list
+APIs for querying and deleting alarms
+Tag management
+APIs for adding tags to log groups, log streams, and host groups
+Quick search
+APIs for creating, querying, and deleting quick search requests
+Calling APIs
+ +++ diff --git a/docs/lts/api-ref/lts_api_0004.html b/docs/lts/api-ref/lts_api_0004.html new file mode 100644 index 000000000..7e22ab550 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0004.html @@ -0,0 +1,144 @@ + + +-
+
- Making an API Request
+
+ - Authentication
+
+ - Response
+
+
Making an API Request
++This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs.
++Request URI
A request URI is in the following format:
+{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}
+Although a request URI is included in the request header, most programming languages or frameworks require the request URI to be transmitted separately.
+- URI-scheme:
Protocol used to transmit requests. All APIs use HTTPS.
+ - Endpoint:
Domain name or IP address of the server bearing the REST service. The endpoint varies between services in different regions. It can be obtained from Regions and Endpoints.
+ - resource-path:
Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the resource-path of the API used to obtain a user token is /v3/auth/tokens.
+ - query-string:
Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "Parameter name=Parameter value". For example, ?limit=10 indicates that a maximum of 10 data records will be displayed.
+
+ To simplify the URI display, each API is provided only with a resource-path and a request method. The URI-scheme of all APIs is HTTPS, and the endpoints of all APIs in the same region are identical.
++Request Methods
The HTTPS protocol defines the following request methods that can be used to send a request to the server:
+- GET: requests a server to return specified resources.
- PUT: requests a server to update specified resources.
- POST: requests a server to add resources or perform special operations.
- DELETE: requests a server to delete specified resources, for example, objects.
- HEAD: same as GET except that the server must return only the response header.
- PATCH: requests a server to update a part of a specified resource. If the resource does not exist, a new resource will be created.
For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows:
++Request Header
You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add Content-Type, which specifies the request body type.
+Common request header fields are as follows: +++
+Table 1 Common request header fields Parameter
+Description
+Mandatory
+Example Value
+Host
+Server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is in the format of Hostname:Port number. If the port number is not specified, the default port is used. The default port number for https is 443.
+No
+This field is mandatory for AK/SK authentication.
+code.test.com
+or
+code.test.com:443
+Content-Type
+Type (or format) of the message body. The default value application/json is recommended. Other values of this field will be provided for specific APIs if any.
+Yes
+application/json
+Content-Length
+Length of the request body. The unit is byte.
+No
+3495
+X-Project-Id
+Project ID. Obtain the project ID by following the instructions in Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID.
+No
+e9993fc787d94b6c886cbaa340f9c0f4
++ In addition to supporting token-based authentication, APIs also support authentication using access key ID/secret access key (AK/SK). During AK/SK-based authentication, an SDK is used to sign a request, and the Authorization (signature information) and X-Sdk-Date (time when the request is sent) header fields are automatically added to the request.
+For details, see "AK/SK-based Authentication" in Authentication.
+The API used to obtain a user token does not require authentication. Therefore, only the Content-Type field needs to be added to requests for calling the API. An example of such requests is as follows:
++Request Body (Optional)
This part is optional. A request body is often sent in a structured format (for example, JSON or XML) as defined in the Content-Type header field. All characters in a request body must be UTF-8 encoded.
+The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods.
+In the case of the API used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace username, domainname, ******** (login password), and xxxxxxxxxxxxxxxxx (project name) with the actual values. Obtain a project name from Regions and Endpoints.
++ The scope parameter specifies where a token takes effect. You can set scope to an account or a project under an account. For details, see Obtaining a User Token.
+++1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25
Content-Type: application/json + +{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxxxxxxxxxxxx" + } + } + } +} +
If all data required for the API request is available, you can send the request to call an API through curl, Postman, or coding. In the response to the API used to obtain a user token, x-subject-token is the desired user token. This token can then be used to authenticate the calling of other APIs.
+++ diff --git a/docs/lts/api-ref/lts_api_0005.html b/docs/lts/api-ref/lts_api_0005.html new file mode 100644 index 000000000..e74f920cb --- /dev/null +++ b/docs/lts/api-ref/lts_api_0005.html @@ -0,0 +1,52 @@ + + +++Parent topic: Calling APIs+Authentication
++You can use either of the following authentication methods when calling APIs:
+- Token-based authentication: Requests are authenticated using a token.
- AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. AK/SK-based authentication is recommended because it is more secure than token-based authentication.
+Token-based Authentication
+ The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token.
+A token is used to acquire temporary permissions. During API authentication using a token, the token is added to requests to get permissions for calling the API.
+You can obtain a token by calling the Obtaining User Token API. When you call the API, set auth.scope in the request body to project.
+{ + "auth": { + "identity": { + "methods": [ + "password" + ], + "password": { + "user": { + "name": "username", + "password": "********", + "domain": { + "name": "domainname" + } + } + } + }, + "scope": { + "project": { + "name": "xxxxxxxx" + } + } + } +}+After a token is obtained, the X-Auth-Token header field must be added to requests to specify the token when calling other APIs. For example, if the token is ABCDEFJ...., X-Auth-Token: ABCDEFJ.... can be added to a request as follows:
++Content-Type: application/json +X-Auth-Token: ABCDEFJ....
++AK/SK-based Authentication
+ AK/SK-based authentication supports API requests with a body no larger than 12 MB. For API requests with a larger body, you should use token-based authentication.
+In AK/SK-based authentication, AK/SK is used to sign requests and the signature is then added to the requests for authentication.
+- AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically.
- SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified.
In AK/SK-based authentication, you can use an AK/SK to sign requests based on the signature algorithm or use the signing SDK to sign requests.
++
The signing SDK is only used for signing requests and is different from the SDKs provided by services.
+++ diff --git a/docs/lts/api-ref/lts_api_0006.html b/docs/lts/api-ref/lts_api_0006.html index b6900de13..c21447225 100644 --- a/docs/lts/api-ref/lts_api_0006.html +++ b/docs/lts/api-ref/lts_api_0006.html @@ -1,16 +1,20 @@ -++Parent topic: Calling APIs+Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID
-Obtaining Account and Project IDs
Account and project IDs are required in URLs when you call some APIs.
+Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID
+-Obtaining Account and Project IDs
Account and project IDs are required in URLs when you call some APIs.
+- Log in to the management console.
- Hover the mouse pointer over the username and choose My Credentials from the drop-down list. + +
- On the My Credentials page, view the account and project IDs. + + +
Obtaining Log Group and Log Stream IDs
- Obtain the IDs from the console.
- Log in to the LTS console.
- On the Log Management page, obtain the log group ID.
- Click the name of a log group and obtain the log stream ID on the page displayed.
- Obtain the IDs by calling APIs. -
Obtaining Log Group and Log Stream IDs
- Log in to the LTS console.
- On the Log Management page, move the cursor to a log group name to view the log group ID.
- Click
of the target log group and move the cursor to a log stream name to view the log stream ID.
diff --git a/docs/lts/api-ref/lts_api_0007.html b/docs/lts/api-ref/lts_api_0007.html new file mode 100644 index 000000000..4024b89f8 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0007.html @@ -0,0 +1,39 @@ + + +-Parent topic: Public Parameters+Parent topic: AppendixResponse
+++Status Code
After sending a request, you will receive a response, including a status code, response header, and response body.
+A status code is a group of digits, ranging from 1xx to 5xx. It indicates the status of a request. For details, see Error Codes.
+For example, if status code 201 is returned for calling the API used to obtain a user token, the request is successful.
++Response Header
Similar to a request, a response also has a header, for example, Content-type.
+Figure 1 shows the response header fields for the API used to obtain a user token. The x-subject-token header field is the desired user token. This token can then be used to authenticate the calling of other APIs.
+ ++Response Body (Optional)
The body of a response is often returned in structured format as specified in the Content-type header field. The response body transfers content except the response header.
+The following is part of the response body for the API used to obtain a user token.
+{ + "token": { + "expires_at": "2019-02-13T06:52:13.855000Z", + "methods": [ + "password" + ], + "catalog": [ + { + "endpoints": [ + { + "region_id": "xxxxx", +......+If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.
+{ + "error_msg": "The format of message is error", + "error_code": "AS.0001" +}+In the response body, error_code is an error code, and error_msg provides information about the error.
+++ diff --git a/docs/lts/api-ref/lts_api_0010.html b/docs/lts/api-ref/lts_api_0010.html new file mode 100644 index 000000000..f3d87c8a5 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0010.html @@ -0,0 +1,41 @@ + + +++Parent topic: Calling APIs+APIs
+ +++ diff --git a/docs/lts/api-ref/lts_api_0011.html b/docs/lts/api-ref/lts_api_0011.html index fc0399be4..7b80e191f 100644 --- a/docs/lts/api-ref/lts_api_0011.html +++ b/docs/lts/api-ref/lts_api_0011.html @@ -1,17 +1,22 @@ --
+
- Log Group Management (Old Version)
+
+ - Log Stream Management (Old Version)
+
+ - Host Group Management
+
+ - Log Group Management
+
+ - Log Stream Management
+
+ - Log Management
+
+ - Log Ingestion
+
+ - Log Transfer
+
+ - Log Collection Beyond Free Quota
+
+ - Cloud Structuring
+
+ - Alarm Topics
+
+ - Message Template Management
+
+ - Keyword Alarm Rules
+
+ - Alarm List
+
+ - Tag Management
+
+ - Quick Search
+
+
Log Group Management (New Version)
- +Log Group Management
+
+diff --git a/docs/lts/api-ref/lts_api_0012.html b/docs/lts/api-ref/lts_api_0012.html deleted file mode 100644 index 81261f9f8..000000000 --- a/docs/lts/api-ref/lts_api_0012.html +++ /dev/null @@ -1,370 +0,0 @@ - - --
-
- Creating a Log Group
+ - Creating a Log Group
- - Querying All Log Groups of an Account
+ - Querying All Log Groups of an Account
- - Modifying a Log Group
+ - Deleting a Log Group
- - Deleting a Log Group
+ - Modifying a Log Group
+Parent topic: APIs+Creating a Log Group
---Function
This API is used to create a log group for log retention and query. You can create a maximum of 100 log groups.
--URI
POST /v2/{project_id}/groups ---
-Table 1 URI parameter Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 32 characters
--Request Parameters
-- -
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Length: 30 characters
--
-Table 3 Request body parameters Parameter
-Mandatory
-Type
-Description
-log_group_name
-Yes
-String
-Name of the log group to be created.
-Minimum length: 1 character
-Maximum length: 64 characters
-Enumerated value:
-- lts-group-01nh
ttl_in_days
-Yes
-Integer
-Log retention duration, in days (fixed to 7 days).
--Response Parameters
Status code: 201
- --
-Table 4 Response body parameter Parameter
-Type
-Description
-log_group_id
-String
-ID of the created log group.
-Value length: 36 characters
-Status code: 400
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 401
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 8 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 503
- --
-Table 9 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
-Example Request
POST https://{endpoint}/v2/{project_id}/groups - -/v2/{project_id}/groups -{ - "log_group_name": "lts-group-01nh", - "ttl_in_days": 7 -}--Example Response
Status code: 201
-{ - "log_group_id":"b6b9332b-091f-4b22-b810-264318d2d664" -}-Status code: 400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0009", - "error_msg" : "Failed to validate the request body" -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0102", - "error_msg" : "Failed to create log group" -}--Status Codes
--
-Status Code
-Description
-201
-The request has succeeded and the log group has been created.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0013.html b/docs/lts/api-ref/lts_api_0013.html deleted file mode 100644 index a8a7850ea..000000000 --- a/docs/lts/api-ref/lts_api_0013.html +++ /dev/null @@ -1,304 +0,0 @@ - - ---Parent topic: Log Group Management (New Version)-Querying All Log Groups of an Account
---Function
This API is used to query all log groups of an account.
--URI
GET /v2/{project_id}/groups
- --
-Table 1 URI parameter Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID. Default value: None
-Value length: 32 characters
--Request Parameters
--
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--Response Parameters
Status code: 200
- -- -
-Table 3 Response body parameter Parameter
-Type
-Description
-log_groups
-Array of LogGroup objects
-Information of log groups.
--
-Table 4 LogGroup Parameter
-Type
-Description
-creation_time
-long
-Time when a log group was created.
-log_group_name
-String
-Log group name.
-Minimum length: 1 character
-Maximum length: 64 characters
-log_group_id
-String
-Log group ID.
-Value length: 36 characters
-ttl_in_days
-Integer
-Log retention duration, in days (fixed to 7 days).
-tag
-Map<String,String>
-Log group tag.
-Status code: 401
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
-Example Request
GET https://{endpoint}/v2/{project_id}/groups - -/v2/{project_id}/groups--Example Response
Status code: 200
-{"log_groups":[{"creation_time":1630547141853,"log_group_name":"lts-group-01nh","log_group_id":"b6b9332b-091f-4b22-b810-264318d2d664","ttl_in_days":7}]}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0010", - "error_msg" : "The system encountered an internal error" -}--Status Codes
--
-Status Code
-Description
-200
-The request is successful.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0014.html b/docs/lts/api-ref/lts_api_0014.html deleted file mode 100644 index 9c8577745..000000000 --- a/docs/lts/api-ref/lts_api_0014.html +++ /dev/null @@ -1,285 +0,0 @@ - - ---Parent topic: Log Group Management (New Version)-Deleting a Log Group
---Function
This API is used to delete a specified log group. If the log streams in a log group have been associated with log transfer tasks, you need to delete the tasks first.
--URI
DELETE /v2/{project_id}/groups/{log_group_id}
- --
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID. Default value: None
-Value length: 32 characters
-log_group_id
-Yes
-String
-Log group ID. For details about how to obtain a log group ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 36 characters
--Request Parameters
--
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--Response Parameters
Status code: 400
- --
-Table 3 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 401
- --
-Table 4 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
-Example Request
DELETE https://{endpoint}/v2/{project_id}/groups/{log_group_id} - -/v2/{project_id}/groups/{log_group_id}--Example Response
Status code: 400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0201", - "error_msg" : "The log group is not existed" -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0103", - "error_msg" : "Failed to delete log group" -}--Status Codes
--
-Status Code
-Description
-204
-The request has succeeded and the log group has been deleted.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0015.html b/docs/lts/api-ref/lts_api_0015.html index 48510c96e..3f0a79aaf 100644 --- a/docs/lts/api-ref/lts_api_0015.html +++ b/docs/lts/api-ref/lts_api_0015.html @@ -1,15 +1,24 @@ ---Parent topic: Log Group Management (New Version)-Log Stream Management (New Version)
- +Log Stream Management
+
+diff --git a/docs/lts/api-ref/lts_api_0016.html b/docs/lts/api-ref/lts_api_0016.html deleted file mode 100644 index c56e945e0..000000000 --- a/docs/lts/api-ref/lts_api_0016.html +++ /dev/null @@ -1,363 +0,0 @@ - - --
-
- Creating a Log Stream
+ - Creating a Log Stream
- - Querying All Log Streams in a Specified Log Group
+ - Querying All Log Streams in a Specified Log Group
- - Deleting a Log Stream
+ - Querying Log Streams
+
+ - Deleting a Log Stream
+
+ - Modifying a Log Stream
+Parent topic: APIs+Creating a Log Stream
---Function
This API is used to create a log stream in a specified log group.
--URI
POST /v2/{project_id}/groups/{log_group_id}/streams
- --
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID. Default value: None
-Value length: 32 characters
-log_group_id
-Yes
-String
-ID of the log group to which the log stream to be created will belong.
-Default value: None
-Value length: 36 characters
--Request Parameters
-- -
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--
-Table 3 Request body parameter Parameter
-Mandatory
-Type
-Description
-log_stream_name
-Yes
-String
-Name of the log stream to be created.
-Minimum length: 1 character
-Maximum length: 64 characters
-Enumerated value:
-- lts-stream-13ci
-Response Parameters
Status code: 201
- --
-Table 4 Response body parameter Parameter
-Type
-Description
-log_stream_id
-String
-ID of the created log stream.
-Value length: 36 characters
-Status code: 400
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 401
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 8 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 503
- --
-Table 9 Response body parameter Parameter
-Type
-Description
--
-String
-The requested service is unavailable.
--Example Request
POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams - -/v2/{project_id}/groups/{log_group_id}/streams -{ - "log_stream_name": "lts-stream-02kh", - "ttl_in_days": 7, - -} ---Example Response
Status code: 201
-{ - "log_stream_id":"c54dbc58-0fd8-48ed-b007-6d54981427a7" -}-Status code: 400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0009", - "error_msg" : "Failed to validate the request body" -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0202", - "error_msg" : "Failed to create Log stream" -}--Status Codes
--
-Status Code
-Description
-201
-The request has succeeded and the log stream has been created.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0017.html b/docs/lts/api-ref/lts_api_0017.html deleted file mode 100644 index 531fdd700..000000000 --- a/docs/lts/api-ref/lts_api_0017.html +++ /dev/null @@ -1,345 +0,0 @@ - - ---Parent topic: Log Stream Management (New Version)-Querying All Log Streams in a Specified Log Group
---Function
This API is used to query information about all log streams in a specified log group.
--URI
GET /v2/{project_id}/groups/{log_group_id}/streams
- --
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID. Default value: None
-Value length: 32 characters
-log_group_id
-Yes
-String
-ID of the log group whose log streams will be queried.
-Default value: None
-Value length: 36 characters
--Request Parameters
--
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--Response Parameters
Status code: 200
- -- -
-Table 3 Response body parameter Parameter
-Type
-Description
-log_streams
-Array of LogStream objects
-List of log streams.
--
-Table 4 LogStream Parameter
-Type
-Description
-creation_time
-long
-Creation time.
-Minimum value: 1577808000000
-Maximum value: 4102416000000
-log_stream_name
-String
-Log stream name.
-Value length: 36 characters
-log_stream_id
-String
-Log stream ID.
-Value length: 36 characters
-filter_count
-Integer
-Number of filters.
-Minimum value: 0
-Maximum value: 5
-tag
-Map<String,String>
-Log stream tag.
-Status code: 401
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 503
- --
-Table 8 Response body parameter Parameter
-Type
-Description
--
-String
-The requested service is unavailable.
--Example Request
GET https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams - -/v2/{project_id}/groups/{log_group_id}/streams--Example Response
Status code: 200
-{ - "log_streams" : [ { - "creation_time":1630549842955, - "log_stream_name":"lts-stream-02kh", - "log_stream_id":"c54dbc58-0fd8-48ed-b007-6d54981427a7", - "filter_count":0 - } ] -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0010", - "error_msg" : "The system encountered an internal error" -}--Status Codes
--
-Status Code
-Description
-200
-The request is successful.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0018.html b/docs/lts/api-ref/lts_api_0018.html deleted file mode 100644 index ca78493ce..000000000 --- a/docs/lts/api-ref/lts_api_0018.html +++ /dev/null @@ -1,316 +0,0 @@ - - ---Parent topic: Log Stream Management (New Version)-Deleting a Log Stream
---Function
This API is used to delete a specified log stream from a specified log group. If a log transfer task has been associated with the log stream, delete the task first.
--URI
DELETE /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}
- --
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 32 characters
-log_group_id
-Yes
-String
-ID of the log group whose log streams will be deleted.
-Default value: None
-Value length: 36 characters
-log_stream_id
-Yes
-String
-ID of the log stream to be deleted. For details about how to obtain the log stream ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 36 characters
--Request Parameters
--
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Value length: 30 characters
--Response Parameters
Status code: 400
- --
-Table 3 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 401
- --
-Table 4 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 503
- --
-Table 7 Response body parameter Parameter
-Type
-Description
--
-String
-The requested service is unavailable.
--Example Request
DELETE https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id} - -/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}--Example Response
Status code: 400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0208", - "error_msg" : "The log stream does not existed" -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0203", - "error_msg" : "Failed to delete Log stream" -}--Status Codes
--
-Status Code
-Description
-204
-The request has succeeded and the log stream has been deleted.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0019.html b/docs/lts/api-ref/lts_api_0019.html new file mode 100644 index 000000000..b68cab606 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0019.html @@ -0,0 +1,15 @@ + + +--Parent topic: Log Stream Management (New Version)-Appendix
+ ++ ++ diff --git a/docs/lts/api-ref/lts_api_0020.html b/docs/lts/api-ref/lts_api_0020.html new file mode 100644 index 000000000..3d200df99 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0020.html @@ -0,0 +1,100 @@ + + +Status Codes
++Table 1 lists the status codes.
+ ++
+Table 1 Status codes Status Code
+Returned Value
+Description
+200
+OK
+The normal response for the GET or PUT operation is returned.
+201
+OK
+The POST request is successful and the query result is returned.
+204
+No Content
+The normal response for the DELETE operation is returned.
+400
+Bad Request
+Request error.
+401
+Unauthorized
+The authentication information is not provided or is incorrect.
+403
+Forbidden
+You are forbidden to access the page requested.
+404
+Not Found
+The server failed to find the requested resource.
+408
+Request Timeout
+The request timed out.
+429
+Too Many Requests
+The number of requests exceeded the upper limit.
+500
+Internal Server Error
+The server encountered an unexpected condition which prevented it from fulfilling the request.
+503
+Service Unavailable
+The service is currently unavailable.
+++ diff --git a/docs/lts/api-ref/lts_api_0023.html b/docs/lts/api-ref/lts_api_0023.html new file mode 100644 index 000000000..4aa9ac950 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0023.html @@ -0,0 +1,59 @@ + + +++Parent topic: Appendix+Change History
+++ diff --git a/docs/lts/api-ref/lts_api_0024.html b/docs/lts/api-ref/lts_api_0024.html deleted file mode 100644 index eb0180595..000000000 --- a/docs/lts/api-ref/lts_api_0024.html +++ /dev/null @@ -1,358 +0,0 @@ - - -+
+Released On
+Description
+2024-12-13
+- Deleted the API for creating an index for a specified log stream.
- Optimized the API description. For example, deleted the maximum, minimum, and default values of response parameters.
2024-08-30
+Added the following APIs: Log Collection Beyond Free Quota, Cloud Structuring, Alarm Topics, Message Template Management, Keyword Alarm Rules, Alarm List, Tag Management, and Quick Search.
+2024-08-15
+Updated the following API: Creating a Log Group.
+2024-05-30
+Added the following APIs: Host Group Management and Log Ingestion.
+Optimized description in Log Group Management, Log Stream Management, Log Management, and Log Transfer.
+2020-08-31
+Replaced the original APIs with the following ones:
+- Creating a log group
- Querying all log groups of an account
- Deleting a log group
- Creating a log stream
- Querying all log streams in a specified log group
- Deleting a log stream
- Querying logs
- Creating a log transfer task (old version)
2019-04-26
+Modified the following content:
+A maximum of 100 log groups and log streams are supported.
+2019-04-19
+Modified the following content:
+- Changed the LTS URL from https://Endpoint/uri to https://lts.eu-de.otc.t-systems.com/uri in the "APIs" section.
- Changed Ttl_in_days to ttl_in_days in the response parameters of the API for querying log groups.
- Deleted log_topics from the response parameters of the API for querying log streams.
2019-03-30
+This issue is the first official release.
+Modifying a Log Group
---Function
This API is used to modify the log retention duration of a specified log group.
--URI
POST /v2/{project_id}/groups/{log_group_id}
- --
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain a project ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 36 characters
-log_group_id
-Yes
-String
-Log group ID. For details about how to obtain a log group ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 36 characters
--Request Parameters
-- -
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--
-Table 3 Request body parameter Parameter
-Mandatory
-Type
-Description
-ttl_in_days
-Yes
-Integer
-Log retention duration, in days (fixed to 7 days).
--Response Parameters
Status code: 200
- --
-Table 4 Response body parameters Parameter
-Type
-Description
-creation_time
-long
-Time when a log group was created.
-log_group_name
-String
-Log group name.
-Minimum length: 1 character
-Maximum length: 64 characters
-log_group_id
-String
-Log group ID.
-Value length: 36 characters
-ttl_in_days
-Integer
-Log retention duration, in days (fixed to 7 days).
-Status code: 400
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0403
error_msg
-String
-Error message.
-Example value:
-- Invalid projectId
Status code: 401
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0403
error_msg
-String
-Error message.
-Example value:
-- Invalid projectId
Status code: 403
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0403
error_msg
-String
-Error message.
-Example value:
-- Invalid projectId
Status code: 500
- --
-Table 8 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0403
error_msg
-String
-Error message.
-Example value:
-- Invalid projectId
-Example Request
POST https://{endpoint}/v2/{project_id}/groups/{log_group_id} - -/v2/{project_id}/groups/{log_group_id} -{ - "ttl_in_days": 8 -}--Example Response
Status code: 200
-{"creation_time" : "number","log_group_name" : "string","log_group_id" : "string","ttl_in_days" : 8}-Status code: 400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0009", - "error_msg" : "Failed to validate the request body" -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0414", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0102", - "error_msg" : "Failed to update log group" -}--Status Codes
--
-Status Code
-Description
-200
-The request has succeeded and the log group has been modified.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0026.html b/docs/lts/api-ref/lts_api_0026.html deleted file mode 100644 index 5ddfaa5b1..000000000 --- a/docs/lts/api-ref/lts_api_0026.html +++ /dev/null @@ -1,17 +0,0 @@ - - ---Parent topic: Log Group Management (New Version)-Log Transfer
- -- -- diff --git a/docs/lts/api-ref/lts_api_0027.html b/docs/lts/api-ref/lts_api_0027.html deleted file mode 100644 index a3b249e3f..000000000 --- a/docs/lts/api-ref/lts_api_0027.html +++ /dev/null @@ -1,449 +0,0 @@ - - -Creating a Log Transfer Task
---Function
This API is used to transfer logs of one or more specified log streams to Object Storage Service (OBS).
--URI
POST /v2/{project_id}/log-dump/obs
- --
-Table 1 URI parameter Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 32 characters
--Request Parameters
-- -
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--
-Table 3 Request body parameters Parameter
-Mandatory
-Type
-Description
-log_group_id
-Yes
-String
-Log group ID.
-Value length: 36 characters
-log_stream_ids
-Yes
-Array of strings
-Indicates IDs of log streams whose logs are to be periodically transferred to OBS. You can specify one or more log streams.
-Example value:
-- 7bb6b1e7-xxxx-4255-87f9-b3dc7fb2xxxx
obs_bucket_name
-Yes
-String
-Indicates the name of an OBS bucket.
-Minimum length: 3 characters
-Maximum length: 63 characters
-type
-Yes
-String
-Set this parameter to cycle, which indicates that the log transfer is periodic.
-Value length: 5 characters
-storage_format
-Yes
-String
-Indicates whether the logs are stored in raw or JSON format. The default value is RAW.
-Minimum length: 3 characters
-Maximum length: 4 characters
-switch_on
-No
-Boolean
-Indicates whether the log transfer is enabled. The value is true (default) or false.
-prefix_name
-No
-String
-Indicates the file name prefix of the log files transferred to an OBS bucket.
-Minimum length: 0 characters
-Maximum length: 64 characters
-dir_prefix_name
-No
-String
-Indicates a custom path to store the log files.
-Minimum length: 0 characters
-Maximum length: 64 characters
-period
-Yes
-Integer
-Indicates the length of the log transfer interval.
-Example values: 1, 2, 3, 5, 6, 12, and 30
-period_unit
-Yes
-String
-Indicates the unit of the log transfer interval.
-Example values: min and hour
-Minimum length: 3 characters
-Maximum length: 4 characters
-NOTE:-The log transfer interval is specified by the combination of the values of period and period_unit, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.
--Response Parameters
Status code: 201
- --
-Table 4 Response body parameter Parameter
-Type
-Description
-log_dump_obs_id
-String
-Transfer task ID.
-Default value: None
-Value length: 36 characters
-Status code: 400
- --
-Table 5 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0007
error_msg
-String
-Error message.
-Example value:
-- The request body format must be json
Status code: 403
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0403
error_msg
-String
-Error message.
-Example value:
-- Invalid projectId
Status code: 500
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Example value:
-- LTS.0403
error_msg
-String
-Error message.
-Example value:
-- Invalid projectId
-Example Request
POST https://{endpoint}/v2/{project_id}/log-dump/obs - -/v2/{project_id}/log-dump/obs -{ - "log_group_id": "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053", - "log_stream_ids": ["45e7f609-xxxx-4cd3-835b-xxxx4a124718"], - "obs_bucket_name": "lts-test", - "type": "cycle", - "storage_format": "RAW", - "switch_on": "true", - "prefix_name": "fileprefixname", - "dir_prefix_name": "dirprefixname", - "period": 5, - "period_unit": "min" -}--Example Response
Status code: 200
-- The log group does not exist.
{ - "error_code": "LTS.0201", - "error_msg": "The log group does not existed" -}- - The log stream does not exist.
{ - "error_code": "LTS.0208", - "error_msg": "Log stream id does not exist: 632b9bdc-5afd-4666-a5de-2579f8b80314-" -}- - The OBS bucket does not exist.
{ - "error_code": "LTS.0416", - "error_msg": "obs bucket does not exist: zhuanchu" -}- - The log stream ID has been associated with a transfer task.
{ - "error_code": "LTS.0207", - "error_msg": "Log stream id is associated by transfer: 632b9bdc-5afd-4666-a5de-2579f8b80314" -}- - Invalid transfer type.
{ - "error_code": "LTS.1901", - "error_msg": "type is not in the list [cycle]" -}- - Invalid storage format.
{ - "error_code": "LTS.1901", - "error_msg": "storage_format is not in the list [RAW, JSON]" -}- - Invalid log transfer interval.
{ - "error_code": "LTS.1901", - "error_msg": "period+period_unit is not in the list [2min, 5min, 30min, 1hour, 3hour, 6hour, 12hour]" -}- - Invalid unit of the log transfer interval.
{ - "error_code": "LTS.1901", - "error_msg": "period_unit is not in the list [min, hour]" -}- - Invalid file name prefix.
{ - "error_code": "LTS.1902", - "error_msg": "prefix_name is invalid, please verify if it's provided as required" -}- - Invalid custom path to store log files.
{ - "error_code": "LTS.1902", - "error_msg": "dir_prefix_name is invalid, please verify if it's provided as required" -}-
Status code: 201
-{ - "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968" -}-Status code: 400
-- The request is invalid. Modify the request based on the description in error_msg before a retry.
{ - "error_code" : "LTS.0009", - "error_msg" : "Failed to validate the request body" -}- - The request is invalid. Modify the request based on the description in error_msg before a retry.
{ - "error_code": "LTS.0007", - "error_msg": "The request body format must be json" -}-
Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-- The server has received the request but encountered an internal error.
{ - "error_code" : "LTS.0202", - "error_msg" : "Failed to query lts struct log" -}-
- The server has received the request but encountered an internal error.
{ - "error_code": "LTS.0010", - "error_msg": "Internal Server Error" -}-
-Status Codes
--
-Status Code
-Description
-200
-The request has succeeded.
-201
-The request has succeeded. The transfer task has been created.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0028.html b/docs/lts/api-ref/lts_api_0028.html deleted file mode 100644 index d0aaded43..000000000 --- a/docs/lts/api-ref/lts_api_0028.html +++ /dev/null @@ -1,921 +0,0 @@ - - ---Parent topic: Log Transfer-Querying Logs
---Function
This API is used to query logs in a specified log stream.
--URI
POST /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query
- --
-Table 1 URI parameters Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain the ID, see Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID.
-Default value: None
-Value length: 32 characters
-log_group_id
-Yes
-String
-Log group ID.
-Default value: None
-Value length: 36 characters
-log_stream_id
-Yes
-String
-Log stream ID.
-Default value: None
-Value length: 36 characters
--Request Parameters
-- -
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Default value: None
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Default value: None
-Minimum length: 30 characters
-Maximum length: 30 characters
--
-Table 3 Request body parameters Parameter
-Mandatory
-Type
-Description
-start_time
-Yes
-String
-Maximum query time range: 30 days
-end_time
-Yes
-String
-UTC end time of the search window (in milliseconds).
-NOTE:-Maximum query time range: 30 days
-labels
-No
-Map<String,String>
-Filter criteria, which vary between log sources.
-keywords
-No
-String
-Keyword used for search. A keyword is a word between two adjacent delimiters.
-Enumerated value:
-- error
line_num
-No
-String
-Sequence number of a log event. This parameter is not required for the first query, but is required for subsequent pagination queries. The value can be obtained from the response of the last query. The value of line_num should be between the values of start_time and end_time.
-Value length: 19 characters
-is_desc
-No
-Boolean
-Whether the search order is descending or ascending. The default value is false, indicating that search results are displayed in ascending order.
-Enumerated value:
-- false
search_type
-No
-String
-The value is init (default value) for the first query, or forwards or backwards for a pagination query. This parameter is used together with is_desc for pagination queries.
-Enumerated value:
-- forwards
limit
-No
-Integer
-Number of logs to be queried each time. The value is 50 when this parameter is not set. You are advised to set this parameter to 100.
-Minimum value: 1
-Maximum value: 5000
--Response Parameters
Status code: 200
- -- -
-Table 4 Response body parameter Parameter
-Type
-Description
-logs
-Array of LogContents objects
-Information of logs.
-count
-Integer
-Number of logs.
--
-Table 5 LogContents Parameter
-Type
-Description
-content
-String
-Raw log data.
-Minimum length: 1 character
-Maximum length: 10,000 characters
-line_num
-String
-Sequence number of a log event.
-Value length: 19 characters
-labels
-Map<String,String>
-Labels contained in a log event. The labels vary depending on log events.
-Status code: 400
- --
-Table 6 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 401
- --
-Table 7 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 403
- --
-Table 8 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 9 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Enumerated value:
-- LTS.0403
error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
-Example Request
Log details:
-2020-07-25/14:44:42 this log is Error NO 1 -2020-07-25/14:44:43 this log is Error NO 2 -2020-07-25/14:44:44 this log is Error NO 3 -2020-07-25/14:44:45 this log is Error NO 4 -2020-07-25/14:44:46 this log is Error NO 5 -2020-07-25/14:44:47 this log is Error NO 6 -2020-07-25/14:44:48 this log is Error NO 7 -2020-07-25/14:44:49 this log is Error NO 8 -2020-07-25/14:44:50 this log is Error NO 9 -2020-07-25/14:44:51 this log is Error NO 10
- -POST https://{endpoint}/v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query-- For the first query:
v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query -{ - "start_time": 1595659200000, - "end_time": 1595659500000, - "labels": - { - "hostName": "ecs-kwxtest" - }, - "keywords": "log", - "limit": 10, - "is_count":true -}-
- For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 6, NO 7, and NO 8 are the target log events):
v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query -{ - "start_time": 1595659200000, - "end_time": 1595659500000, - "labels": - { - "hostName": "ecs-kwxtest" - }, - "keywords": "log", - "line_num": "1595659490239433658", - "is_desc": "false", - "search_type": "forwards", - "limit": "3", - "is_count":true -}- - For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 8, NO 7, and NO 6 are the target log events):
{ - "start_time": 1595659200000, - "end_time": 1595659500000, - "labels": - { - "hostName": "ecs-kwxtest" - }, - "keywords": "log", - "line_num": "1595659490239433658", - "is_desc": "true", - "search_type": "backwards", - "limit": "3", - "is_count":true -}- - For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 2, NO 3, and NO 4 are the target log events):
v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query -{ - "start_time": 1595659200000, - "end_time": 1595659500000, - "labels": - { - "hostName": "ecs-kwxtest" - }, - "keywords": "log", - "line_num": "1595659490239433658", - "is_desc": "false", - "search_type": "backwards", - "limit": "3", - "is_count":true -}- - For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 4, NO 3, and NO 2 are the target log events):
v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/query -{ - "start_time": 1595659200000, - "end_time": 1595659500000, - "labels": - { - "hostName": "ecs-kwxtest" - }, - "keywords": "log", - "line_num": "1595659490239433658", - "is_desc": "true", - "search_type": "forwards", - "limit": "3", - "is_count":true -}-
-Example Response
- For the first query:
{ - "count": 32, - "logs": [ - { - "content": "2020-07-25/14:44:42 this <HighLightTag>log</HighLightTag> is Error NO 1\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433654" - }, - { - "content": "2020-07-25/14:44:43 this <HighLightTag>log</HighLightTag> is Error NO 2\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433655" - }, - { - "content": "2020-07-25/14:44:44 this <HighLightTag>log</HighLightTag> is Error NO 3\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433656" - }, - { - "content": "2020-07-25/14:44:45 this <HighLightTag>log</HighLightTag> is Error NO 4\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433657" - }, - { - "content": "2020-07-25/14:44:46 this <HighLightTag>log</HighLightTag> is Error NO 5\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433658" - }, - { - "content": "2020-07-25/14:44:47 this <HighLightTag>log</HighLightTag> is Error NO 6\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433659" - }, - { - "content": "2020-07-25/14:44:48 this <HighLightTag>log</HighLightTag> is Error NO 7\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433660" - }, - { - "content": "2020-07-25/14:44:49 this <HighLightTag>log</HighLightTag> is Error NO 8\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433661" - }, - { - "content": "2020-07-25/14:44:50 this <HighLightTag>log</HighLightTag> is Error NO 9\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490839420574" - }, - { - "content": "2020-07-25/14:44:51 this <HighLightTag>log</HighLightTag> is Error NO 10\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659491839412667" - } -] -}-
- For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 6, NO 7, and NO 8 are the target log events):
{ - "count": 32, - "logs": [ - { - "content": "2020-07-25/14:44:47 this <HighLightTag>log</HighLightTag> is Error NO 6\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433659" - }, - { - "content": "2020-07-25/14:44:48 this <HighLightTag>log</HighLightTag> is Error NO 7\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433660" - }, - { - "content": "2020-07-25/14:44:49 this <HighLightTag>log</HighLightTag> is Error NO 8\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433661" - } - ] -}- - For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 8, NO 7, and NO 6 are the target log events):
{ - "count": 32, - "logs": [ - { - "content": "2020-07-25/14:44:49 this <HighLightTag>log</HighLightTag> is Error NO 8\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433661" - }, - { - "content": "2020-07-25/14:44:48 this <HighLightTag>log</HighLightTag> is Error NO 7\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433660" - }, - { - "content": "2020-07-25/14:44:47 this <HighLightTag>log</HighLightTag> is Error NO 6\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433659" - } - ] -}- - For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 2, NO 3, and NO 4 are the target log events):
{ - "count": 32, - "logs": [ - { - "content": "2020-07-25/14:44:43 this <HighLightTag>log</HighLightTag> is Error NO 2\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433655" - }, - { - "content": "2020-07-25/14:44:44 this <HighLightTag>log</HighLightTag> is Error NO 3\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433656" - }, - { - "content": "2020-07-25/14:44:45 this <HighLightTag>log</HighLightTag> is Error NO 4\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433657" - } - ] -}- - For a pagination query (Assume that the search starts from the log event containing NO 5 and the log events containing NO 4, NO 3, and NO 2 are the target log events):
{ - "count": 32, - "logs": [ - { - "content": "2020-07-25/14:44:45 this <HighLightTag>log</HighLightTag> is Error NO 4\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433657" - }, - { - "content": "2020-07-25/14:44:44 this <HighLightTag>log</HighLightTag> is Error NO 3\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433656" - }, - { - "content": "2020-07-25/14:44:43 this <HighLightTag>log</HighLightTag> is Error NO 2\n", - "labels": { - "hostName": "ecs-kwxtest", - "hostIP": "192.168.0.156", - "appName": "default_appname", - "containerName": "CONFIG_FILE", - "clusterName": "CONFIG_FILE", - "hostId": "9787ef31-fd7b-4eff-ba71-72d580f11f55", - "podName": "default_procname", - "clusterId": "CONFIG_FILE", - "nameSpace": "CONFIG_FILE", - "category": "LTS" - }, - "line_num": "1595659490239433655" - } - ] -}-
Status code: 400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0009", - "error_msg" : "Failed to validate the request body" -}-Status code: 401
-Authentication failed. Check the token and try again.
-{ - "error_code" : "LTS.0003", - "error_msg" : "Invalid token" -}-Status code: 403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-{ - "error_code" : "LTS.0001", - "error_msg" : "Invalid projectId" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0202", - "error_msg" : "Failed to query lts log" -}--Status Codes
--
-Status Code
-Description
-200
-The request is successful.
-400
-The request is invalid. Modify the request based on the description in error_msg before a retry.
-401
-Authentication failed. Check the token and try again.
-403
-The server understood the request but refused to authorize it. The client should not repeat the request without modifications.
-500
-The server has received the request but encountered an internal error.
-503
-The requested service is unavailable.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0029.html b/docs/lts/api-ref/lts_api_0029.html index e7b728e31..84262a5a6 100644 --- a/docs/lts/api-ref/lts_api_0029.html +++ b/docs/lts/api-ref/lts_api_0029.html @@ -1,11 +1,430 @@ ---Parent topic: Log Management-Log Management
- ---
-
- Querying Logs
-
-
Creating a Log Transfer Task (Old Version)
+++Function
This API is used to transfer logs of one or more specified log streams to Object Storage Service (OBS).
++URI
POST /v2/{project_id}/log-dump/obs
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++Request Parameters
++ +
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++
+Table 3 Request body parameters Parameter
+Mandatory
+Type
+Description
+log_group_id
+Yes
+String
+Log group ID.
+Minimum: 36
+Maximum: 36
+log_stream_ids
+Yes
+Array of strings
+Indicates IDs of log streams whose logs are to be periodically transferred to OBS. You can specify one or more log streams.
+obs_bucket_name
+Yes
+String
+Name of an OBS bucket.
+Minimum: 3
+Maximum: 63
+type
+Yes
+String
+Set this parameter to cycle, which indicates that the log transfer is periodic.
+Minimum: 5
+Maximum: 5
+storage_format
+Yes
+String
+Whether the logs are stored in raw or JSON format. The default value is RAW.
+Minimum length: 3 characters.
+Maximum length: 4 characters.
+switch_on
+No
+Boolean
+Whether log transfer is enabled. The value is true (default) or false.
+prefix_name
+No
+String
+The file name prefix of the log files transferred to an OBS bucket.
+Minimum: 0
+Maximum: 64
+dir_prefix_name
+No
+String
+A custom path to store the log files.
+Minimum: 0
+Maximum: 64
+period
+Yes
+Integer
+Length of the log transfer interval.
+period_unit
+Yes
+String
+Unit of the log transfer interval.>The combination of period and period_unit must be one of ["2min","5min","30min","1hour","3hour","6hour","12hour"].
+Minimum: 3
+Maximum: 4
++Response Parameters
Status code: 201
+ ++
+Table 4 Response body parameters Parameter
+Type
+Description
+log_dump_obs_id
+String
+Transfer task ID.
+Status code: 400
+ ++
+Table 5 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 403
+ ++
+Table 6 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 7 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Creating a log transfer task
+POST https://{endpoint}/v2/{project_id}/log-dump/obs + +{ + "log_group_id" : "d9dba9f3-xxxx-48bd-xxxx-xxxxa24a8053", + "log_stream_ids" : [ "45e7f609-xxxx-4cd3-835b-xxxx4a124718" ], + "obs_bucket_name" : "lts-test", + "type" : "cycle", + "storage_format" : "RAW", + "switch_on" : "true", + "prefix_name" : "fileprefixname", + "dir_prefix_name" : "dirprefixname", + "period" : 5, + "period_unit" : "min" +}++Example Responses
Status code: 200
+The request is successful.
+The log group does not exist.
+{ + "error_code" : "LTS.0201", + "error_msg" : "The log group does not existed" +}+The log stream does not exist.
+{ + "error_code" : "LTS.0208", + "error_msg" : "Log stream id does not exist: 632b9bdc-5afd-4666-a5de-2579f8b80314-" +}+The OBS bucket does not exist.
+{ + "error_code" : "LTS.0416", + "error_msg" : "obs bucket does not exist: zhuanchu" +}+The log stream ID has been associated during log transfer.
+{ + "error_code" : "LTS.0207", + "error_msg" : "Log stream id is associated by transfer: 632b9bdc-5afd-4666-a5de-2579f8b80314" +}+The transfer type is not in the list.
+{ + "error_code" : "LTS.1901", + "error_msg" : "type is not in the list [cycle]" +}+The transfer format is not in the list.
+{ + "error_code" : "LTS.1901", + "error_msg" : "storage_format is not in the list [RAW, JSON]" +}+The transfer interval is not in the list.
+{ + "error_code" : "LTS.1901", + "error_msg" : "period+period_unit is not in the list [2min, 5min, 30min, 1hour, 3hour, 6hour, 12hour]" +}+The transfer unit is not in the list.
+{ + "error_code" : "LTS.1901", + "error_msg" : "period_unit is not in the list [min, hour]" +}+The prefix of the transferred log file is invalid. Check the prefix.
+{ + "error_code" : "LTS.1902", + "error_msg" : "prefix_name is invalid, please verify if it's provided as required" +}+The prefix of the custom transfer path is invalid. Check the prefix.
+{ + "error_code" : "LTS.1902", + "error_msg" : "dir_prefix_name is invalid, please verify if it's provided as required" +}+
Status code: 201
+The request is successful.
+{ + "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968" +}+Status code: 400
+BadRequest. The request is invalid. Modify the request based on the description in error_msg before a retry.
+BadRequest. The request is invalid. Modify the request based on the description in **error_msg** before a retry. +{ + "error_code": "LTS.0007", + "error_msg": "The request body format must be json" +}+Status code: 403
+Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+{ + "error_code" : "LTS.0001", + "error_msg" : "Invalid projectId" +}+Status code: 500
+InternalServerError.
+The server has received the request but encountered an internal error.
+InternalServerError. The server has received the request but encountered an internal error. +{ + "error_code": "LTS.0010", + "error_msg": "Internal Server Error"}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+201
+The request is successful.
+400
+BadRequest. The request is invalid. Modify the request based on the description in error_msg before a retry.
+403
+Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+500
+InternalServerError.
+The server has received the request but encountered an internal error.
++Error Codes
See Error Codes.
++diff --git a/docs/lts/api-ref/lts_api_0030.html b/docs/lts/api-ref/lts_api_0030.html deleted file mode 100644 index 81c174937..000000000 --- a/docs/lts/api-ref/lts_api_0030.html +++ /dev/null @@ -1,474 +0,0 @@ - - -+Parent topic: Log Transfer+Deleting a Log Transfer Task
---Function
This API is used to delete an OBS transfer task.
--URI
DELETE /v2/{project_id}/transfers
- -- -
-Table 1 URI parameter Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain a project ID, see Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID.
-Minimum length: 32 characters
-Maximum length: 32 characters
--
-Table 2 Query parameters Parameter
-Mandatory
-Type
-Description
-log_transfer_id
-Yes
-String
-Log transfer ID. You can obtain the ID by calling the API for querying a log transfer task or for creating a log transfer task.
-Minimum length: 36 characters
-Maximum length: 36 characters
--Request Parameters
--
-Table 3 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Minimum length: 30 characters
-Maximum length: 30 characters
--Response Parameters
Status code: 200
- -- -
-Table 4 Response body parameters Parameter
-Type
-Description
-log_group_id
-String
-Log group ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_group_name
-String
-Log group name.
-Minimum length: 1 character
-Maximum length: 64 characters
-log_streams
-Array of log_streams objects
-Log stream list.
-log_transfer_id
-String
-Log transfer task ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_transfer_info
-Table 6 object
-Log transfer information.
-- -
-Table 5 log_streams Parameter
-Type
-Description
-log_stream_id
-String
-Log stream ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_stream_name
-String
-Log stream name.
-Minimum length: 1 character
-Maximum length: 64 characters
-- -
-Table 6 log_transfer_info Parameter
-Type
-Description
-log_agency_transfer
-Table 7 object
-Information about delegated log transfer. This parameter is returned for a delegated log transfer task.
-log_create_time
-Integer
-Time when the log transfer task was created.
-Minimum value: 0
-Maximum value: 9999999999999
-log_storage_format
-String
-Log transfer format. The value can be RAW or JSON. RAW indicates raw log format, whereas JSON indicates JSON format. JSON and RAW are supported for OBS and DIS transfer tasks, but only RAW is supported for DMS transfer tasks.
-Enumerated values:
-- JSON
- RAW
log_transfer_detail
-Object
-Log transfer details.
-log_transfer_mode
-String
-Log transfer mode. cycle indicates periodical transfer, whereas realTime indicates real-time transfer. cycle is available to OBS transfer tasks and realTime is available to DIS and DMS transfer tasks.
-Enumerated values:
-- cycle
- realTime
log_transfer_status
-String
-Log transfer status. ENABLE indicates that log transfer is enabled, DISABLE indicates that log transfer is disabled, and EXCEPTION indicates that log transfer is abnormal.
-Enumerated values:
-- ENABLE
- DISABLE
- EXCEPTION
log_transfer_type
-String
-Log transfer type. You can transfer logs to OBS, DIS, and DMS.
-Enumerated values:
-- OBS
-
-Table 7 log_agency_transfer Parameter
-Type
-Description
-agency_domain_id
-String
-Delegator account ID.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_domain_name
-String
-Delegator account name.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_name
-String
-Name of the agency created by the delegator.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_project_id
-String
-Project ID of the delegator.
-Minimum length: 32 characters
-Maximum length: 32 characters
-be_agency_domain_id
-String
-Account ID of the delegated party (ID of the account that created the log transfer task).
-Minimum length: 1 character
-Maximum length: 128 characters
-be_agency_project_id
-String
-Project ID of the delegated party (project ID of the account that created the log transfer task).
-Minimum length: 32 characters
-Maximum length: 32 characters
-Status code: 400
- --
-Table 8 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Minimum length: 8 characters
-Maximum length: 8 characters
-error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 9 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Minimum length: 8 characters
-Maximum length: 8 characters
-error_msg
-String
-Error message.
--Example Request
Deleting a log transfer task based on the task ID
-DELETE https://{endpoint}/v2/{project_id}/transfers - -/v2/{project_id}/transfers?log_transfer_id=cfc43c45-9edc-4a03-8578-0eb00cxxxxxx--Example Response
Status code: 200
-The log transfer task is deleted.
-{ - "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0", - "log_group_name" : "lts-group-kafka", - "log_streams" : [{ - "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8", - "log_stream_name" : "lts-topic-kafka" - } - ], - "log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc", - "log_transfer_info" : { - "log_create_time" : 1634802241847, - "log_storage_format" : "JSON", - "log_agency_transfer" : { - "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", - "agency_domain_name" : "paas_apm_z004xxxxx_xx", - "agency_name" : "test20210325", - "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx", - "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", - "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx" - }, - "log_transfer_detail" : { - //The following parameters are returned for an OBS transfer task: - "obs_period":2, - "obs_prefix_name":"", - "obs_period_unit":"min", - "obs_transfer_path":"/0002/LogTanks/xxx/", - "obs_bucket_name":"0002", - "obs_encrypted_enable":false, - "obs_dir_pre_fix_name":"", - "obs_time_zone": "UTC+01:00", - "obs_time_zone_id": "Africa/Lagos", - //The following parameters are returned for a DIS transfer task: - "dis_id":"xxxxx", - "dis_name":"xxxxxx" - //The following parameters are returned for a DMS transfer task: - "kafka_id":"xxxxxx", - "kafka_topic":"xxxxx" - }, - "log_transfer_mode":"cycle", - "log_transfer_status":"ENABLE", - "log_transfer_type":"OBS" - } -}-Status code: 400
-Invalid request. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0207", - "error_msg" : "The log stream is associated by transfer" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0010", - "error_msg" : "The system encountered an internal error" -}--Status Codes
--
-Status Code
-Description
-200
-The log transfer task is deleted.
-400
-Invalid request. Modify the request based on the description in error_msg before a retry.
-500
-The server has received the request but encountered an internal error.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0031.html b/docs/lts/api-ref/lts_api_0031.html deleted file mode 100644 index 8ff7dd792..000000000 --- a/docs/lts/api-ref/lts_api_0031.html +++ /dev/null @@ -1,661 +0,0 @@ - - ---Parent topic: Log Transfer-Updating a Log Transfer Task
---Function
This API is used to update an OBS transfer task.
--URI
PUT /v2/{project_id}/transfers
- --
-Table 1 URI parameter Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain a project ID, see Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID.
-Minimum length: 32 characters
-Maximum length: 32 characters
--Request Parameters
-- -
-Table 2 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Minimum length: 30 characters
-Maximum length: 30 characters
-- -
-Table 3 Request body parameters Parameter
-Mandatory
-Type
-Description
-log_transfer_id
-Yes
-String
-Log transfer task ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_transfer_info
-Yes
-Table 4 object
-Log transfer information.
-- -
-Table 4 log_transfer_info Parameter
-Mandatory
-Type
-Description
-log_storage_format
-Yes
-String
-Log transfer format. The value can be RAW or JSON. RAW indicates raw log format, whereas JSON indicates JSON format. JSON and RAW are supported for OBS and DIS transfer tasks, but only RAW is supported for DMS transfer tasks.
-Enumerated values:
-- JSON
- RAW
log_transfer_status
-Yes
-String
-Log transfer status. ENABLE indicates that log transfer is enabled, DISABLE indicates that log transfer is disabled, and EXCEPTION indicates that log transfer is abnormal.
-Enumerated values:
-- ENABLE
- DISABLE
- EXCEPTION
log_transfer_detail
-Yes
-Table 5 object
-Log transfer details.
--
-Table 5 log_transfer_detail Parameter
-Mandatory
-Type
-Description
-obs_period
-Yes
-Integer
-Length of the transfer interval for an OBS transfer task. This parameter is required to update an OBS transfer task. The log transfer interval is specified by the combination of the values of obs_period and obs_period_unit, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.
-Enumerated values:
-- 1
- 2
- 3
- 5
- 6
- 12
- 30
obs_period_unit
-Yes
-String
-Unit of the transfer interval for an OBS transfer task. This parameter is required to update an OBS transfer task. The log transfer interval is specified by the combination of the values of obs_period and obs_period_unit, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.
-Enumerated values:
-- min
- hour
obs_bucket_name
-Yes
-String
-OBS bucket name. This parameter is required to update an OBS transfer task.
-Minimum length: 3 characters
-Maximum length: 63 characters
-obs_encrypted_id
-No
-String
-KMS key ID for an OBS transfer task. This parameter is required if encryption is enabled for the target OBS bucket.
-Minimum length: 36 characters
-Maximum length: 36 characters
-obs_dir_pre_fix_name
-No
-String
-Custom transfer path of an OBS transfer task. This parameter is optional.
-The value must match the regular expression:
-^(/)?([a-zA-Z0-9\._-]+)(/[a-zA-Z0-9\._-]+)*(/)?$
-Minimum length: 1 character
-Maximum length: 64 characters
-obs_prefix_name
-No
-String
-Transfer file prefix of an OBS transfer task. This parameter is optional.
-The value must match the regular expression:
-^[a-zA-Z0-9\._-]*$
-Minimum length: 1 character
-Maximum length: 64 characters
-obs_transfer_path
-No
-string
-OBS bucket path, which is the log transfer destination.
-obs_eps_id
-No
-string
-Enterprise project ID of an OBS transfer task.
-obs_encrypted_enable
-No
-boolean
-Whether OBS bucket encryption is enabled.
-tags
-No
-Array< String >
-If tag delivery is enabled, this field must contain the following host information: hostIP, hostId, hostName, pathFile, and collectTime.
-(Optional) Common fields include logStreamName, regionName, logGroupName, and projectId.
-(Optional) Enable the transfer tag: streamTag.
--Response Parameters
Status code: 200
- -- -
-Table 6 Response body parameters Parameter
-Type
-Description
-log_group_id
-String
-Log group ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_group_name
-String
-Log group name.
-Minimum length: 1 character
-Maximum length: 64 characters
-log_streams
-Array of Table 7 objects
-Log stream list.
-log_transfer_id
-String
-Log transfer task ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_transfer_info
-Table 8 object
-Log transfer information.
-- -
-Table 7 log_streams Parameter
-Type
-Description
-log_stream_id
-String
-Log stream ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_stream_name
-String
-Log stream name.
-Minimum length: 1 character
-Maximum length: 64 characters
-- -
-Table 8 log_transfer_info Parameter
-Type
-Description
-log_agency_transfer
-Table 9 object
-Information about delegated log transfer. This parameter is returned for a delegated log transfer task.
-log_create_time
-Integer
-Time when the log transfer task was created.
-Minimum value: 0
-Maximum value: 9999999999999
-log_storage_format
-String
-Log transfer format. The value can be RAW or JSON. RAW indicates raw log format, whereas JSON indicates JSON format. OBS transfer tasks support JSON.
-Enumerated values:
-- JSON
- RAW
log_transfer_detail
-Object
-Log transfer details.
-log_transfer_mode
-String
-Log transfer mode. cycle indicates periodical transfer, whereas realTime indicates real-time transfer. cycle is available to OBS transfer tasks and realTime is available to DIS and DMS transfer tasks.
-Enumerated values:
-- cycle
- realTime
log_transfer_status
-String
-Log transfer status. ENABLE indicates that log transfer is enabled, DISABLE indicates that log transfer is disabled, and EXCEPTION indicates that log transfer is abnormal.
-Enumerated values:
-- ENABLE
- DISABLE
- EXCEPTION
log_transfer_type
-String
-Log transfer type. You can transfer logs to OBS.
-Enumerated values:
-- OBS
-
-Table 9 log_agency_transfer Parameter
-Type
-Description
-agency_domain_id
-String
-Delegator account ID.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_domain_name
-String
-Delegator account name.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_name
-String
-Name of the agency created by the delegator.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_project_id
-String
-Project ID of the delegator.
-Minimum length: 32 characters
-Maximum length: 32 characters
-be_agency_domain_id
-String
-Account ID of the delegated party (ID of the account that created the log transfer task).
-Minimum length: 1 character
-Maximum length: 128 characters
-be_agency_project_id
-String
-Project ID of the delegated party (project ID of the account that created the log transfer task).
-Minimum length: 32 characters
-Maximum length: 32 characters
-Status code: 400
- --
-Table 10 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Minimum length: 8 characters
-Maximum length: 8 characters
-error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
Status code: 500
- --
-Table 11 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Minimum length: 8 characters
-Maximum length: 8 characters
-error_msg
-String
-Error message.
--Example Request
- Updating an OBS transfer taskPUT https://{endpoint}/v2/{project_id}/transfers-
PUT https://{endpoint}/v2/{project_id}/transfers - - /v2/{project_id}/transfers - { - "log_transfer_id" : "9f74e101-b969-483c-a610-d3f3064xxxxx", - "log_transfer_info" : { - "log_storage_format" : "JSON", - "log_transfer_status" : "DISABLE", - "log_transfer_detail" : { - "obs_period" : 3, - "obs_period_unit" : "hour", - "obs_bucket_name" : "0xxx", - "obs_encrypted_id" : "1bd90032-1424-481f-8558-ba49854xxxxx", - "obs_dir_pre_fix_name" : "xx", - "obs_prefix_name" : "xxxxx" - } - } -}-
-Example Response
Status code: 200
-The transfer task is updated.
-The following parameters are returned for an OBS transfer task:-{ - "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0", - "log_group_name" : "lts-group-kafka", - "log_streams" : [{ - "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8", - "log_stream_name" : "lts-topic-kafka" - } - ], - "log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc", - "log_transfer_info" : { - "log_create_time" : 1634802241847, - "log_storage_format" : "JSON", - "log_agency_transfer" : { - "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", - "agency_domain_name" : "paas_apm_z004xxxxx_xx", - "agency_name" : "test20210325", - "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx", - "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", - "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx" - }, - "log_transfer_detail" : { - "obs_period":2, - "obs_prefix_name":"", - "obs_period_unit":"min", - "obs_transfer_path":"/0002/LogTanks/cn-north-7/", - "obs_bucket_name":"0002", - "obs_encrypted_enable":false, - "obs_dir_pre_fix_name":"", - "obs_time_zone": "UTC+01:00", - "obs_time_zone_id": "Africa/Lagos", - "tags": [] - }, - "log_transfer_mode":"cycle", - "log_transfer_status":"ENABLE", - "log_transfer_type":"OBS" - } -}-Status code: 400
-Invalid request. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0207", - "error_msg" : "The log stream is associated by transfer" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0010", - "error_msg" : "The system encountered an internal error" -}--Status Codes
--
-Status Code
-Description
-200
-The transfer task is updated.
-400
-Invalid request. Modify the request based on the description in error_msg before a retry.
-500
-The server has received the request but encountered an internal error.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0032.html b/docs/lts/api-ref/lts_api_0032.html deleted file mode 100644 index 77ce086ab..000000000 --- a/docs/lts/api-ref/lts_api_0032.html +++ /dev/null @@ -1,650 +0,0 @@ - - ---Parent topic: Log Transfer-Querying a Log Transfer Task
---Function
This API is used to query an OBS transfer task.
--URI
GET /v2/{project_id}/transfers
- -- -
-Table 1 URI parameter Parameter
-Mandatory
-Type
-Description
-project_id
-Yes
-String
-Project ID. For details about how to obtain a project ID, see Obtaining the Account ID, Project ID, Log Group ID, and Log Stream ID.
-Minimum length: 32 characters
-Maximum length: 32 characters
--
-Table 2 Query parameters Parameter
-Mandatory
-Type
-Description
-log_transfer_type
-No
-String
-Log transfer type. You can transfer logs to OBS, DIS, and DMS.
-Enumerated values:
-- OBS
- DIS
- DMS
log_group_name
-No
-String
-Log group name.
-Minimum length: 1 character
-Maximum length: 64 characters
-log_stream_name
-No
-String
-Log stream name.
-Minimum length: 1 character
-Maximum length: 64 characters
-offset
-No
-Integer
-Query cursor. Set the value to 0 in the first query. In subsequent queries, obtain the value from the response to the last request.
-Minimum value: 0
-Maximum value: 1024
-limit
-No
-Integer
-Number of records on each page.
-Minimum value: 0
-Maximum value: 100
--Request Parameters
--
-Table 3 Request header parameters Parameter
-Mandatory
-Type
-Description
-X-Auth-Token
-Yes
-String
-User token obtained from IAM.
-Minimum length: 1000 characters
-Maximum length: 2000 characters
-Content-Type
-Yes
-String
-Set this parameter to application/json;charset=UTF-8.
-Minimum length: 30 characters
-Maximum length: 30 characters
--Response Parameters
Status code: 200
- -- -
-Table 4 Response body parameters Parameter
-Type
-Description
-log_transfers
-Array of Table 5 objects
-Log transfer task information.
-- -
-Table 5 CreateTransferResponseBody Parameter
-Type
-Description
-log_group_id
-String
-Log group ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_group_name
-String
-Log group name.
-Minimum length: 1 character
-Maximum length: 64 characters
-log_streams
-Array of Table 6 objects
-Log stream list.
-log_transfer_id
-String
-Log transfer task ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_transfer_info
-Table 7 object
-Log transfer information.
-- -
-Table 6 log_streams Parameter
-Type
-Description
-log_stream_id
-String
-Log stream ID.
-Minimum length: 36 characters
-Maximum length: 36 characters
-log_stream_name
-String
-Log stream name.
-Minimum length: 1 character
-Maximum length: 64 characters
-- -
-Table 7 log_transfer_info Parameter
-Type
-Description
-log_agency_transfer
-Table 8 object
-Information about delegated log transfer. This parameter is returned for a delegated log transfer task.
-log_create_time
-Integer
-Time when the log transfer task was created.
-Minimum value: 0
-Maximum value: 9999999999999
-log_storage_format
-String
-Log transfer format. The value can be RAW or JSON. RAW indicates raw log format, whereas JSON indicates JSON format. JSON and RAW are supported for OBS and DIS transfer tasks, but only RAW is supported for DMS transfer tasks.
-Enumerated values:
-- JSON
- RAW
log_transfer_detail
-Object
-Log transfer details.
-log_transfer_mode
-String
-Log transfer mode. cycle indicates periodical transfer, whereas realTime indicates real-time transfer. cycle is available to OBS transfer tasks and realTime is available to DIS and DMS transfer tasks.
-Enumerated values:
-- cycle
- realTime
log_transfer_status
-String
-Log transfer status. ENABLE indicates that log transfer is enabled, DISABLE indicates that log transfer is disabled, and EXCEPTION indicates that log transfer is abnormal.
-Enumerated values:
-- ENABLE
- DISABLE
- EXCEPTION
log_transfer_type
-String
-Log transfer type. You can transfer logs to OBS, DIS, and DMS.
-Enumerated values:
-- OBS
- DIS
- DMS
-
-Table 8 log_agency_transfer Parameter
-Type
-Description
-agency_domain_id
-String
-Delegator account ID.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_domain_name
-String
-Delegator account name.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_name
-String
-Name of the agency created by the delegator.
-Minimum length: 1 character
-Maximum length: 128 characters
-agency_project_id
-String
-Project ID of the delegator.
-Minimum length: 32 characters
-Maximum length: 32 characters
-be_agency_domain_id
-String
-Account ID of the delegated party (ID of the account that created the log transfer task).
-Minimum length: 1 character
-Maximum length: 128 characters
-be_agency_project_id
-String
-Project ID of the delegated party (project ID of the account that created the log transfer task).
-Minimum length: 32 characters
-Maximum length: 32 characters
-Status code: 400
- -- -
-Table 9 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Minimum length: 8 characters
-Maximum length: 8 characters
-error_msg
-String
-Error message.
-Enumerated value:
-- Invalid projectId
-
-Table 10 log_transfer_detail Parameter
-Mandatory
-Type
-Description
-obs_period
-Yes
-Integer
-Length of the transfer interval for an OBS transfer task. This parameter is required to update an OBS transfer task. The log transfer interval is specified by the combination of the values of obs_period and obs_period_unit, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.
-Enumerated values:
-- 1
- 2
- 3
- 5
- 6
- 12
- 30
obs_period_unit
-Yes
-String
-Unit of the transfer interval for an OBS transfer task. This parameter is required to update an OBS transfer task. The log transfer interval is specified by the combination of the values of obs_period and obs_period_unit, and must be set to one of the following: 2 min, 5 min, 30 min, 1 hour, 3 hours, 6 hours, and 12 hours.
-Enumerated values:
-- min
- hour
obs_bucket_name
-Yes
-String
-OBS bucket name. This parameter is required to update an OBS transfer task.
-Minimum length: 3 characters
-Maximum length: 63 characters
-obs_encrypted_id
-No
-String
-KMS key ID for an OBS transfer task. This parameter is required if encryption is enabled for the target OBS bucket.
-Minimum length: 36 characters
-Maximum length: 36 characters
-obs_dir_pre_fix_name
-No
-String
-Custom transfer path of an OBS transfer task. This parameter is optional.
-The value must match the regular expression:
-^(/)?([a-zA-Z0-9\._-]+)(/[a-zA-Z0-9\._-]+)*(/)?$
-Minimum length: 1 character
-Maximum length: 64 characters
-obs_prefix_name
-No
-String
-Transfer file prefix of an OBS transfer task. This parameter is optional.
-The value must match the regular expression:
-^[a-zA-Z0-9\._-]*$
-Minimum length: 1 character
-Maximum length: 64 characters
-obs_transfer_path
-No
-string
-OBS bucket path, which is the log transfer destination.
-obs_eps_id
-No
-string
-Enterprise project ID of an OBS transfer task.
-obs_encrypted_enable
-No
-boolean
-Whether OBS bucket encryption is enabled.
-Status code: 500
- --
-Table 11 Response body parameters Parameter
-Type
-Description
-error_code
-String
-Error code.
-Minimum length: 8 characters
-Maximum length: 8 characters
-error_msg
-String
-Error message.
--Example Request
If no parameter is specified, all log transfer tasks are returned. If log_transfer_type, log_group_name, and log_stream_name are specified, the corresponding log transfer task is returned.
-GET https://{endpoint}/v2/{project_id}/transfers - -/v2/{project_id}/transfers -/v2/{project_id}/transfers?log_group_name=lts-group-txxx -/v2/{project_id}/transfers?log_transfer_type=OBS -/v2/{project_id}/transfers?log_stream_name=lts-topic-testRexxx -/v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_transfer_type=OBS -/v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_stream_name=lts-topic-testRxxx -/v2/{project_id}/transfers?log_transfer_type=OBS&log_stream_name=lts-topic-testRxxx -/v2/{project_id}/transfers?log_group_name=lts-group-txxx&log_transfer_type=OBS&log_stream_name=lts-topic-testRexxx--Example Response
Status code: 200
-The query is successful.
-The following parameters are returned for an OBS transfer task:
-{ - "log_transfers" : [{ - "log_group_id" : "9a7e2183-2d6d-4732-9a9b-e897fd4e49e0", - "log_group_name" : "lts-group-kafka", - "log_streams" : [{ - "log_stream_id" : "839dac89-35af-4db2-ab4a-a7dda0d0d3f8", - "log_stream_name" : "lts-topic-kafka" - } - ], - "log_transfer_id" : "ddced522-233a-4181-a5fc-7b458c819afc", - "log_transfer_info" : { - "log_create_time" : 1634802241847, - "log_storage_format" : "JSON", - "log_agency_transfer" : { - "agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", - "agency_domain_name" : "paas_apm_z004xxxxx_xx", - "agency_name" : "test20210325", - "agency_project_id" : "2a473356cca5487f8373be891bfxxxxx", - "be_agency_domain_id" : "1d26cc8c86a840e28a4f8d0d078xxxxx", - "be_agency_project_id" : "2a473356cca5487f8373be891bfxxxxx" - }, - "log_transfer_detail" : { - "obs_period":2, - "obs_prefix_name":"", - "obs_period_unit":"min", - "obs_transfer_path":"/0002/LogTanks/xxx/", - "obs_bucket_name":"0002", - "obs_encrypted_enable":false, - "obs_dir_pre_fix_name":"" - }, - "log_transfer_mode":"cycle", - "log_transfer_status":"ENABLE", - "log_transfer_type":"OBS" - } - } - ] -}-Status code: 400
-Invalid request. Modify the request based on the description in error_msg before a retry.
-{ - "error_code" : "LTS.0205", - "error_msg" : "The log stream name has been existed" -}-Status code: 500
-The server has received the request but encountered an internal error.
-{ - "error_code" : "LTS.0010", - "error_msg" : "The system encountered an internal error" -}--Status Codes
--
-Status Code
-Description
-200
-The query is successful.
-400
-Invalid request. Modify the request based on the description in error_msg before a retry.
-500
-The server has received the request but encountered an internal error.
--Error Codes
For details, see Error Codes.
--- diff --git a/docs/lts/api-ref/lts_api_0041.html b/docs/lts/api-ref/lts_api_0041.html new file mode 100644 index 000000000..48cad67b2 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0041.html @@ -0,0 +1,566 @@ + + +--Parent topic: Log Transfer-Querying a Structuring Rule
+++Function
This API is used to query the structuring rule of a specified log stream.
++URI
GET /v2/{project_id}/lts/struct/template
+ ++ +
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+logGroupId
+Yes
+String
+Log group ID. For details about how to obtain a log group ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 36
+Maximum: 36
+logStreamId
+Yes
+String
+Log stream ID. For details about how to obtain a log stream ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 36
+Maximum: 36
++Request Parameters
++
+Table 3 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++Response Parameters
Status code: 200
+ ++ +
+Table 4 Response body parameters Parameter
+Type
+Description
+demoFields
+Array of StructFieldInfoReturn objects
+Structured field.
+tagFields
+Array of tag_fields_info objects
+Keyword details.
+demoLog
+String
+Sample log event.
+demoLabel
+String
+Attributes of the sample log event.
+id
+String
+Structuring rule ID.
+logGroupId
+String
+Log group ID.
+rule
+ShowStructTemplateRule object
+Structuring method.
+cluster_info
++ +Kafka information.
+logStreamId
+String
+Log stream ID.
+projectId
+String
+Project ID.
+templateName
+String
+Template name.
+regex
+String
+Regular expression.
++ +
+Table 5 StructFieldInfoReturn Parameter
+Type
+Description
+fieldName
+String
+Field name.
+type
+String
+Field data type.
+content
+String
+Field content.
+isAnalysis
+Boolean
+Whether parsing is enabled.
+index
+Integer
+Field sequence number.
++ +
+Table 6 tag_fields_info Parameter
+Type
+Description
+fieldName
+String
+Field name.
+type
+String
+Field type.
+content
+String
+Content.
+isAnalysis
+Boolean
+Whether parsing is enabled.
+index
+Integer
+Field sequence number.
++ +
+Table 7 ShowStructTemplateRule Parameter
+Type
+Description
+param
+String
+Structuring parameter.
+type
+String
+Structuring type.
++
+Table 8 ShowStructTemplateclusterInfo Parameter
+Type
+Description
+cluster_name
+String
+Kafka cluster name.
+kafka_bootstrap_servers
+String
+Kafka cluster server address.
+kafka_ssl_enable
+Boolean
+Whether SSL encrypted authentication is enabled for Kafka.
+Status code: 400
+ ++
+Table 9 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 401
+ ++
+Table 10 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 403
+ ++
+Table 11 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 12 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
GET https://{endpoint}/v2/{project_id}/lts/struct/template?logGroupId=123456&logStreamId=654321++Example Responses
Status code: 200
+Details of the structuring rule are returned.
+{ + "demoFields" : [ { + "content" : "100.19.10.178", + "fieldName" : "authority", + "index" : 0, + "isAnalysis" : true, + "type" : "string" + }, { + "content" : "0", + "fieldName" : "bytes_received", + "index" : 0, + "isAnalysis" : true, + "type" : "string" + }, { + "content" : "1127", + "fieldName" : "bytes_sent", + "index" : 0, + "isAnalysis" : true, + "type" : "string" + } ] +}+Status code: 400
+BadRequest. The request is invalid. Modify the request based on the description in error_msg before a retry.
+{ + "errorCode" : "SVCSTG.ALS.200201", + "errorMessage" : "Query Param is error." +}+Status code: 401
+AuthFailed. Authentication failed. Check the token and try again.
+{ + "error_code" : "LTS.0414", + "error_msg" : "Invalid token" +}+Status code: 403
+Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+{ + "error_code" : "LTS.0001", + "error_msg" : "Invalid projectId" +}+Status code: 500
+InternalServerError.
+The server has received the request but encountered an internal error.
+{ + "error_code" : "LTS.0102", + "error_msg" : "Query empty." +}++Status Codes
++
+Status Code
+Description
+200
+Details of the structuring rule are returned.
+400
+BadRequest. The request is invalid. Modify the request based on the description in error_msg before a retry.
+401
+AuthFailed. Authentication failed. Check the token and try again.
+403
+Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+500
+InternalServerError.
+The server has received the request but encountered an internal error.
+503
+ServiceUnavailable. The requested service is unavailable.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0044.html b/docs/lts/api-ref/lts_api_0044.html new file mode 100644 index 000000000..903468e14 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0044.html @@ -0,0 +1,320 @@ + + +++Parent topic: Cloud Structuring+Deleting a Structuring Rule
+++Function
This API is used to delete a structuring rule of a log stream.
++URI
DELETE /v2/{project_id}/lts/struct/template
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++Request Parameters
++ +
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++
+Table 3 Request body parameters Parameter
+Mandatory
+Type
+Description
+id
+Yes
+String
+Structuring rule ID.
+Minimum: 106
+Maximum: 106
++Response Parameters
Status code: 200
+ ++
+Table 4 Response body parameters Parameter
+Type
+Description
+error_code
+String
+SVCSTG.ALS.200200
+error_msg
+String
+delete struct config successfully
+Status code: 400
+ ++
+Table 5 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 401
+ ++
+Table 6 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 403
+ ++
+Table 7 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 8 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Deleting the structuring rule of the current ID
+DELETE https://{endpoint}/v2/{project_id}/lts/struct/template + +/v2/{project_id}/lts/struct/template +{ + "id": "2a473356cca5487f8373be891bffc1cf_8a75b77d-7d72-4d7e-8c50-a24562cf8b0b_fd5e1a7c-7412-475d-a013-8891d539574e" +}++Example Responses
Status code: 200
+The structuring rule is deleted.
+{ + "id" : "xxxxxx" +}+Status code: 400
+BadRequest. The request is invalid. Modify the request based on the description in error_msg before a retry.
+{ + "errorCode" : "LTS.0612", + "errorMessage" : "timee fieldType is error" +}+Status code: 401
+AuthFailed. Authentication failed. Check the token and try again.
+{ + "error_code" : "LTS.0414", + "error_msg" : "Invalid token" +}+Status code: 403
+Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+{ + "error_code" : "LTS.0001", + "error_msg" : "Invalid projectId" +}+Status code: 500
+InternalServerError.
+The server has received the request but encountered an internal error.
+{ + "error_code" : "LTS.0010", + "error_msg" : "Internal Server Error" +}++Status Codes
++
+Status Code
+Description
+200
+The structuring rule is deleted.
+400
+BadRequest. The request is invalid. Modify the request based on the description in error_msg before a retry.
+401
+AuthFailed. Authentication failed. Check the token and try again.
+403
+Forbidden.The request has been rejected.The server has received the request and understood it, but refuses to respond to it. The client should not repeat the request without modifications.
+500
+InternalServerError.
+The server has received the request but encountered an internal error.
+503
+ServiceUnavailable. The requested service is unavailable.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0061.html b/docs/lts/api-ref/lts_api_0061.html new file mode 100644 index 000000000..a81817719 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0061.html @@ -0,0 +1,308 @@ + + +++Parent topic: Cloud Structuring+Querying an SMN Topic
+++Function
This API is used to query an SMN topic.
++URI
GET /v2/{project_id}/lts/notifications/topics
+ ++ +
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+offset
+Yes
+Integer
+Query cursor. Set the value to 0 in the first query. In subsequent queries, obtain the value from the response to the last request.
+Minimum: 0
+Maximum: 1024
+limit
+Yes
+Integer
+Number of records on each page. The maximum value is 100.
+Minimum: 0
+Maximum: 100
+fuzzy_name
+No
+String
+Specifies the name of the topic to be searched for, which is fuzzy match. startwith is used for the fuzzy match.
++Request Parameters
++
+Table 3 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++Response Parameters
Status code: 200
+ ++ +
+Table 4 Response body parameters Parameter
+Type
+Description
+request_id
+String
+Unique ID of a request.
+topic_count
+Integer
+Number of topics.
+topics
+Array of Topics objects
+Topic information.
++
+Table 5 Topics Parameter
+Type
+Description
+name
+String
+Topic name.
+topic_urn
+String
+Specifies the resource identifier of the topic, which is unique.
+display_name
+String
+Specifies the topic display name, which is presented as the name of the email sender in email messages.
+push_policy
+Integer
+Specifies the message push policy.
+Status code: 400
+ ++
+Table 6 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 7 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Querying an SMN topic
+GET https://{endpoint}/v2/{project_id}/lts/notifications/topics + +/v2/{project_id}/lts/notifications/topics?offset={offset}&limit={limit}++Example Responses
Status code: 200
+The request is successful.
+{ + "request_id" : "1", + "topic_count" : 100, + "topics" : [ { + "name" : "test", + "topic_urn" : "urn:smn:xxxx-7:{projectId}:fyy", + "display_name" : "username", + "push_policy" : 0 + } ] +}+Status code: 400
+Insufficient permissions.
+{ + "error_code" : "LTS.2009", + "error_msg" : "User must have SMN service authority." +}+Status code: 500
+The request is successful but the service is abnormal.
+{ + "error_code" : "LTS.0010", + "error_msg" : "Internal Server Error" +}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+400
+Insufficient permissions.
+500
+The request is successful but the service is abnormal.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0081.html b/docs/lts/api-ref/lts_api_0081.html new file mode 100644 index 000000000..e62f95817 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0081.html @@ -0,0 +1,674 @@ + + +++Parent topic: Alarm Topics+Creating a Keyword Alarm Rule
+++Function
This API is used to create a keyword alarm. Currently, each account can create a maximum of 200 keyword alarms and SQL alarms.
++URI
POST /v2/{project_id}/lts/alarms/keywords-alarm-rule
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++Request Parameters
++ +
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++ +
+Table 3 Request body parameters Parameter
+Mandatory
+Type
+Description
+keywords_alarm_rule_name
+Yes
+String
+Keyword alarm rule names.
+NOTE:+Cannot start with a period (.) or underscore (_) or end with a period (.).
+Minimum: 1
+Maximum: 64
+keywords_alarm_rule_description
+No
+String
+Keyword alarm description.
+Minimum: 0
+Maximum: 64
+keywords_requests
+Yes
+Array of KeywordsRequest objects
+Keyword details.
+frequency
+Yes
+Frequency object
+Alarm statistical period.
+keywords_alarm_level
+Yes
+String
+Alarm severity.
+keywords_alarm_send
+Yes
+Boolean
+Whether to send an alarm.
+domain_id
+Yes
+String
+Account ID. For details about how to obtain an account ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
+trigger_condition_count
+No
+Integer
+Number of times that log events meet the trigger condition. The default value is 1.
+trigger_condition_frequency
+No
+Integer
+Number of queries in which the triggering condition is met. The default value is 1.
+whether_recovery_policy
+No
+Boolean
+Whether to enable the alarm clearance notification. The default value is false.
+recovery_policy
+No
+Integer
+Number of queries in which the triggering condition is not met. The alarm is cleared when this number reaches the value (3 by default) of this parameter.
+notification_frequency
+Yes
+Integer
+Notification frequency, in minutes.
+alarm_action_rule_name
+No
+String
+Alarm action rule name.
+NOTE:+Set alarm_action_rule_name or notification_save_rule. If you set both of them, the value of alarm_action_rule_name is prioritized.
+notification_save_rule
+No
+SqlNotificationSaveRule object
+Notification topic, which will be unavailable soon. You are advised to use the alarm action rule function.
++ +
+Table 4 KeywordsRequest Parameter
+Mandatory
+Type
+Description
+log_stream_id
+Yes
+String
+Log stream ID.
+log_stream_name
+No
+String
+Log stream name.
+log_group_id
+Yes
+String
+Log group ID.
+log_group_name
+No
+String
+Log group name.
+keywords
+Yes
+String
+Keyword.
+condition
+Yes
+String
+Condition.
+number
+Yes
+Integer
+Keyword threshold, which forms a condition with keyword and condition. An alarm is triggered when the condition is met.
+search_time_range
+Yes
+Integer
+Time range for querying the latest data when a task is executed.
+search_time_range_unit
+Yes
+String
+Query time unit.
++ +
+Table 5 Frequency Parameter
+Mandatory
+Type
+Description
+type
+Yes
+String
+Time type.
+cron_expr
+No
+String
+Cron expression, which uses the 24-hour format and is precise down to the minute.
+• 0/10 * * * *: The query starts from 00:00 and is performed every 10 minutes at 00:00, 00:10, 00:20, 00:30, 00:40, 00:50, 01:00, and so on. For example, if the current time is 16:37, the next query is at 16:50.
+• 0 0/5 * * *: The query starts from 00:00 and is performed every 5 hours at 00:00, 05:00, 10:00, 15:00, 20:00, and so on. For example, if the current time is 16:37, the next query is at 20:00.
+• 0 14 * * *: The query is performed at 14:00 every day.
+• 0 0 10 * *: The query is performed at 00:00 on the 10th day of every month.
+hour_of_day
+No
+Integer
+This field is used when type is set to DAILY or WEEKLY.
+DAILY ranges from 0 to 23.
+WEEKLY ranges from 0 to 23.
+day_of_week
+No
+Integer
+This field is used when type is set to WEEKLY (from Sunday to Saturday).
+fixed_rate
+No
+Integer
+Value of a period. This field is used when type is set to FIXED_RATE. It is used together with fixed_rate_unit to indicate a fixed period.
+fixed_rate_unit
+No
+String
+Unit of a period. This field is used when type is set to FIXED_RATE. It is used together with fixed_rate to indicate a fixed period.
+The value can be hour or minute.
++ +
+Table 6 SqlNotificationSaveRule Parameter
+Mandatory
+Type
+Description
+language
+Yes
+String
+Language of the preference.
+Minimum: 0
+Maximum: 10
+timezone
+No
+String
+Time zone information used in a notification. Example: +08:00
+Minimum: 0
+Maximum: 1024
+user_name
+Yes
+String
+Username used in a notification. It is generally displayed in the first line of the greeting.
+Minimum: 1
+Maximum: 1024
+topics
+Yes
+Array of Topics objects
+Topic information, which will be unavailable soon. You are advised to use the action rule function.
+template_name
+Yes
+String
+Message template name.
++
+Table 7 Topics Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Topic name.
+topic_urn
+Yes
+String
+Specifies the resource identifier of the topic, which is unique.
+display_name
+No
+String
+Specifies the topic display name, which is presented as the name of the email sender in email messages.
+push_policy
+No
+Integer
+Specifies the message push policy.
++Response Parameters
Status code: 200
+ ++
+Table 8 Response body parameters Parameter
+Type
+Description
+keywords_alarm_rule_id
+String
+Alarm rule ID.
+Status code: 400
+ ++
+Table 9 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 10 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Creating a keyword alarm rule
+POST https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule + +{ + "keywords_alarm_rule_name" : "test", + "keywords_alarm_rule_description" : "test", + "keywords_requests" : [ { + "log_stream_id" : "1", + "log_group_id" : "1", + "keywords" : "test", + "condition" : ">", + "number" : "100", + "search_time_range" : 10, + "search_time_range_unit" : "minute" + } ], + "frequency" : { + "type" : "FIXED_RATE", + "cron_expr" : "", + "hour_of_day" : 0, + "day_of_week" : 0, + "fixed_rate" : 10, + "fixed_rate_unit" : "minute" + }, + "keywords_alarm_level" : "Critical", + "keywords_alarm_send" : true, + "domain_id" : "", + "notification_frequency" : 5, + "alarm_action_rule_name" : "", + "notification_save_rule" : { + "language" : "en-us", + "timezone" : "xx/xx", + "user_name" : "test", + "template_name" : "Message template name.", + "topics" : [ { + "name" : "test", + "topic_urn" : "urn:smn:xxxx-7:1b06fc5dc0814a4da1594a9ade9cb93c:test", + "display_name" : "", + "push_policy" : 0 + } ] + } +}++Example Responses
Status code: 200
+The request is successful.
+{ + "keywords_alarm_rule_id" : "cf46fce8-f8b5-4aff-85c0-35d0c828ea0c" +}+Status code: 400
+Invalid request. Modify the request based on the description in error_msg before a retry.
+{ + "error_code" : "LTS.2005", + "error_msg" : "Alarm rule params validator error." +}+Status code: 500
+The server has received the request but encountered an internal error.
+{ + "error_code" : "LTS.2001", + "error_msg" : "Failed to create alarm rule." +}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+400
+Invalid request. Modify the request based on the description in error_msg before a retry.
+500
+The server has received the request but encountered an internal error.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0082.html b/docs/lts/api-ref/lts_api_0082.html new file mode 100644 index 000000000..58289f4a0 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0082.html @@ -0,0 +1,1032 @@ + + +++Parent topic: Keyword Alarm Rules+Modifying a Keyword Alarm Rule
+++Function
This API is used to modify a keyword alarm.
++URI
PUT /v2/{project_id}/lts/alarms/keywords-alarm-rule
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++Request Parameters
++ +
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++ +
+Table 3 Request body parameters Parameter
+Mandatory
+Type
+Description
+keywords_alarm_rule_id
+Yes
+String
+Keyword alarm rule ID.
+Minimum: 36
+Maximum: 36
+keywords_alarm_rule_name
+Yes
+String
+Original rule name, which cannot be changed.
+Minimum: 1
+Maximum: 64
+alarm_rule_alias
+No
+String
+Rule name.
+Minimum: 1
+Maximum: 64
+keywords_alarm_rule_description
+No
+String
+Keyword alarm description.
+Minimum: 0
+Maximum: 64
+keywords_requests
+Yes
+Array of KeywordsRequest objects
+Keyword details.
+frequency
+Yes
+Frequency object
+Alarm statistical period.
+keywords_alarm_level
+Yes
+String
+Alarm severity.
+keywords_alarm_send
+Yes
+Boolean
+Whether to send an alarm.
+keywords_alarm_send_code
+Yes
+Integer
+Subject. 0: unchanged; 1: added; 2: modified; 3: deleted.
+Minimum: 0
+Maximum: 3
+domain_id
+Yes
+String
+Account ID. For details about how to obtain an account ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
+notification_save_rule
+No
+SqlNotificationSaveRule object
+Notification topic, which will be unavailable soon. You are advised to use the alarm action rule function.
+trigger_condition_count
+No
+Integer
+Number of times that log events meet the trigger condition. The default value is 1.
+trigger_condition_frequency
+No
+Integer
+Number of queries in which the triggering condition is met. The default value is 1.
+whether_recovery_policy
+No
+Boolean
+Whether to enable the alarm clearance notification. The default value is false.
+recovery_policy
+No
+Integer
+Number of queries in which the triggering condition is not met. The alarm is cleared when this number reaches the value (3 by default) of this parameter.
+notification_frequency
+Yes
+Integer
+Notification frequency, in minutes.
+alarm_action_rule_name
+No
+String
+Alarm action rule name.
+NOTE:+Set alarm_action_rule_name or notification_save_rule. If you set both of them, the value of alarm_action_rule_name is prioritized.
++ +
+Table 4 KeywordsRequest Parameter
+Mandatory
+Type
+Description
+log_stream_id
+Yes
+String
+Log stream ID.
+log_stream_name
+No
+String
+Log stream name.
+log_group_id
+Yes
+String
+Log group ID.
+log_group_name
+No
+String
+Log group name.
+keywords
+Yes
+String
+Keyword.
+condition
+Yes
+String
+Condition.
+number
+Yes
+Integer
+Keyword threshold, which forms a condition with keyword and condition. An alarm is triggered when the condition is met.
+search_time_range
+Yes
+Integer
+Time range for querying the latest data when a task is executed.
+search_time_range_unit
+Yes
+String
+Query time unit.
++ +
+Table 5 Frequency Parameter
+Mandatory
+Type
+Description
+type
+Yes
+String
+Time type.
+cron_expr
+No
+String
+Cron expression, which uses the 24-hour format and is precise down to the minute.
+• 0/10 * * * *: The query starts from 00:00 and is performed every 10 minutes at 00:00, 00:10, 00:20, 00:30, 00:40, 00:50, 01:00, and so on. For example, if the current time is 16:37, the next query is at 16:50.
+• 0 0/5 * * *: The query starts from 00:00 and is performed every 5 hours at 00:00, 05:00, 10:00, 15:00, 20:00, and so on. For example, if the current time is 16:37, the next query is at 20:00.
+• 0 14 * * *: The query is performed at 14:00 every day.
+• 0 0 10 * *: The query is performed at 00:00 on the 10th day of every month.
+hour_of_day
+No
+Integer
+This field is used when type is set to DAILY or WEEKLY.
+DAILY ranges from 0 to 23.
+WEEKLY ranges from 0 to 23.
+day_of_week
+No
+Integer
+This field is used when type is set to WEEKLY (from Sunday to Saturday).
+fixed_rate
+No
+Integer
+Value of a period. This field is used when type is set to FIXED_RATE. It is used together with fixed_rate_unit to indicate a fixed period.
+fixed_rate_unit
+No
+String
+Unit of a period. This field is used when type is set to FIXED_RATE. It is used together with fixed_rate to indicate a fixed period.
+The value can be hour or minute.
++ +
+Table 6 SqlNotificationSaveRule Parameter
+Mandatory
+Type
+Description
+language
+Yes
+String
+Language of the preference.
+Minimum: 0
+Maximum: 10
+timezone
+No
+String
+Time zone information used in a notification. Example: +08:00
+Minimum: 0
+Maximum: 1024
+user_name
+Yes
+String
+Username used in a notification. It is generally displayed in the first line of the greeting.
+Minimum: 1
+Maximum: 1024
+topics
+Yes
+Array of Topics objects
+Topic information, which will be unavailable soon. You are advised to use the action rule function.
+template_name
+Yes
+String
+Message template name.
++
+Table 7 Topics Parameter
+Mandatory
+Type
+Description
+name
+Yes
+String
+Topic name.
+topic_urn
+Yes
+String
+Specifies the resource identifier of the topic, which is unique.
+display_name
+No
+String
+Specifies the topic display name, which is presented as the name of the email sender in email messages.
+push_policy
+No
+Integer
+Specifies the message push policy.
++Response Parameters
Status code: 200
+ ++ +
+Table 8 Response body parameters Parameter
+Type
+Description
+keywords_alarm_rule_id
+String
+Keyword alarm ID.
+keywords_alarm_rule_name
+String
+Original rule name.
+alarm_rule_alias
+String
+Rule name.
+keywords_alarm_rule_description
+String
+Keyword alarm description.
+keywords_requests
+Array of KeywordsResBody objects
+Keyword details.
+frequency
+FrequencyRespBody object
+Alarm statistical period.
+keywords_alarm_level
+String
+Alarm severity.
+keywords_alarm_send
+Boolean
+Whether to send an alarm.
+domain_id
+String
+domainId
+create_time
+Long
+Creation time (timestamp in milliseconds).
+update_time
+Long
+Update time (timestamp in milliseconds).
+language
+String
+Language of information added to emails.
+projectId
+String
+Project ID.
+topics
+Array of Topics objects
+Notification topic, which will be unavailable soon. You are advised to use the alarm action rule function.
+condition_expression
+String
+Description.
+indexId
+String
+Index ID.
+notification_frequency
+Integer
+Notification frequency, in minutes.
+alarm_action_rule_name
+String
+Alarm action rule name.
+NOTE:+Set alarm_action_rule_name or notification_save_rule. If you set both of them, the value of alarm_action_rule_name is prioritized.
++ +
+Table 9 KeywordsResBody Parameter
+Type
+Description
+log_stream_id
+String
+Log stream ID.
+log_stream_name
+String
+Log stream name.
+log_group_id
+String
+Log group ID.
+log_group_name
+String
+Log group name.
+keywords
+String
+Keyword
+condition
+String
+Condition
+number
+Integer
+Number of lines.
+search_time_range
+Integer
+Time range for querying the latest data when a task is executed. The maximum value is 60.
+search_time_range_unit
+String
+Query time unit.
++ +
+Table 10 FrequencyRespBody Parameter
+Type
+Description
+type
+String
+Time type.
+cron_expr
+String
+This field is used when type is set to CRON.
+hour_of_day
+Integer
+This field is used when type is set to DAILY or WEEKLY.
+day_of_week
+Integer
+This field is used when type is set to WEEKLY (Sunday to Saturday).
+fixed_rate
+Integer
+This field is used when type is set to FIXED_RATE. If the unit of fixed_rate_unit is minute, the maximum value is 60. If the unit is hour, the maximum value is 24.
+fixed_rate_unit
+String
+Enumerated values of the time unit:
++
+Table 11 Topics Parameter
+Type
+Description
+name
+String
+Topic name.
+topic_urn
+String
+Specifies the resource identifier of the topic, which is unique.
+display_name
+String
+Specifies the topic display name, which is presented as the name of the email sender in email messages.
+push_policy
+Integer
+Specifies the message push policy.
+Status code: 400
+ ++
+Table 12 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 13 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Modifying a keyword alarm rule
+PUT https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule + +{ + "keywords_alarm_rule_id" : "", + "keywords_alarm_rule_name" : "test", + "alarm_rule_alias" : "zhangsan", + "keywords_alarm_rule_description" : "test", + "keywords_requests" : [ { + "log_stream_id" : "1", + "log_group_id" : "1", + "keywords" : "test", + "condition" : ">", + "number" : "100", + "search_time_range" : 10, + "search_time_range_unit" : "minute" + } ], + "frequency" : { + "type" : "FIXED_RATE", + "cron_expr" : "", + "hour_of_day" : 0, + "day_of_week" : 0, + "fixed_rate" : 10, + "fixed_rate_unit" : "minute" + }, + "keywords_alarm_level" : "Critical", + "keywords_alarm_send" : true, + "keywords_alarm_send_code" : "2", + "domain_id" : "", + "notification_frequency" : 5, + "alarm_action_rule_name" : "", + "notification_save_rule" : { + "language" : "en-us", + "timezone" : "xx/xx", + "user_name" : "test", + "template_name" : "Message template name.", + "topics" : [ { + "name" : "test", + "topic_urn" : "urn:smn:xxxx-7:1b06fc5dc0814a4da1594a9ade9cb93c:test", + "display_name" : "", + "push_policy" : 0 + } ] + } +}++Example Responses
Status code: 200
+The request is successful.
+{ + "keywords_alarm_rule_id" : "", + "keywords_alarm_rule_name" : "test", + "keywords_alarm_rule_description" : "test", + "alarm_rule_alias" : "zhangsan", + "keywords_requests" : [ { + "log_stream_id" : "1", + "log_stream_name" : "test", + "log_group_name" : "test", + "log_group_id" : "1", + "keywords" : "test", + "condition" : ">", + "number" : "100", + "search_time_range" : 10, + "search_time_range_unit" : "minute" + } ], + "frequency" : { + "type" : "FIXED_RATE", + "cron_expr" : "", + "hour_of_day" : 0, + "day_of_week" : 0, + "fixed_rate" : 10, + "fixed_rate_unit" : "minute" + }, + "keywords_alarm_level" : "Critical", + "keywords_alarm_send" : false, + "domain_id" : "", + "notification_frequency" : 5, + "alarm_action_rule_name" : "", + "topics" : [ { + "name" : "test", + "topic_urn" : "urn:smn:xxxx-7:1b06fc5dc0814a4da1594a9ade9cb93c:test", + "display_name" : "", + "push_policy" : 0 + } ], + "language" : "en-us" +}+Status code: 400
+Invalid request. Modify the request based on the description in error_msg before a retry.
+{ + "error_code" : "LTS.2005", + "error_msg" : "Alarm rule params validator error." +}+Status code: 500
+The server has received the request but encountered an internal error.
+{ + "error_code" : "LTS.2003", + "error_msg" : "Failed to update alarm rule." +}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+400
+Invalid request. Modify the request based on the description in error_msg before a retry.
+500
+The server has received the request but encountered an internal error.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0083.html b/docs/lts/api-ref/lts_api_0083.html new file mode 100644 index 000000000..68c9d2386 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0083.html @@ -0,0 +1,625 @@ + + +++Parent topic: Keyword Alarm Rules+Querying a Keyword Alarm Rule
+++Function
This API is used to query a keyword alarm.
++URI
GET /v2/{project_id}/lts/alarms/keywords-alarm-rule
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++Request Parameters
++
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++Response Parameters
Status code: 200
+ ++ +
+Table 3 Response body parameters Parameter
+Type
+Description
+keywords_alarm_rules
+Array of KeywordsAlarmRuleRespList objects
+Project ID.
++ +
+Table 4 KeywordsAlarmRuleRespList Parameter
+Type
+Description
+projectId
+String
+Project ID.
+keywords_alarm_rule_id
+String
+Keyword alarm ID.
+keywords_alarm_rule_name
+String
+Keyword alarm rule name.
+keywords_alarm_rule_description
+String
+Keyword alarm description.
+condition_expression
+String
+Condition.
+keywords_requests
+Array of KeywordsRequest objects
+Keyword details.
+frequency
+Frequency object
+Alarm statistical period.
+keywords_alarm_level
+String
+Alarm severity.
+keywords_alarm_send
+Boolean
+Whether to send an alarm.
+domain_id
+String
+Domain ID
+create_time
+Long
+Creation time (timestamp in milliseconds).
+update_time
+Long
+Update time (timestamp in milliseconds).
+topics
+Array of Topics objects
+Notification topic, which will be unavailable soon. You are advised to use the action rule function.
+template_name
+String
+Message template name.
+status
+String
+Alarm status.
+trigger_condition_count
+Integer
+Number of queries in which the triggering condition is met. The default value is 1.
+trigger_condition_frequency
+Integer
+Number of times that log events meet the trigger condition. The default value is 1.
+whether_recovery_policy
+Boolean
+Whether to enable the alarm clearance notification. The default value is false.
+recovery_policy
+Integer
+Number of queries in which the triggering condition is not met. The alarm is cleared when this number reaches the value (3 by default) of this parameter.
+notification_frequency
+Integer
+Notification frequency, in minutes.
+alarm_action_rule_name
+String
+Alarm action rule name.
+id
+String
+The value is the same as that of keywords_alarm_rule_id.
+indexId
+String
+The value is the same as that of keywords_alarm_rule_id.
+key
+String
+The value is the same as that of keywords_alarm_rule_id.
++ +
+Table 5 KeywordsRequest Parameter
+Type
+Description
+log_stream_id
+String
+Log stream ID.
+log_stream_name
+String
+Log stream name.
+log_group_id
+String
+Log group ID.
+log_group_name
+String
+Log group name.
+keywords
+String
+Keyword.
+condition
+String
+Condition.
+number
+Integer
+Keyword threshold, which forms a condition with keyword and condition. An alarm is triggered when the condition is met.
+search_time_range
+Integer
+Time range for querying the latest data when a task is executed.
+search_time_range_unit
+String
+Query time unit.
++ +
+Table 6 Frequency Parameter
+Type
+Description
+type
+String
+Time type.
+cron_expr
+String
+Cron expression, which uses the 24-hour format and is precise down to the minute.
+• 0/10 * * * *: The query starts from 00:00 and is performed every 10 minutes at 00:00, 00:10, 00:20, 00:30, 00:40, 00:50, 01:00, and so on. For example, if the current time is 16:37, the next query is at 16:50.
+• 0 0/5 * * *: The query starts from 00:00 and is performed every 5 hours at 00:00, 05:00, 10:00, 15:00, 20:00, and so on. For example, if the current time is 16:37, the next query is at 20:00.
+• 0 14 * * *: The query is performed at 14:00 every day.
+• 0 0 10 * *: The query is performed at 00:00 on the 10th day of every month.
+hour_of_day
+Integer
+This field is used when type is set to DAILY or WEEKLY.
+DAILY ranges from 0 to 23.
+WEEKLY ranges from 0 to 23.
+day_of_week
+Integer
+This field is used when type is set to WEEKLY (from Sunday to Saturday).
+fixed_rate
+Integer
+Value of a period. This field is used when type is set to FIXED_RATE. It is used together with fixed_rate_unit to indicate a fixed period.
+fixed_rate_unit
+String
+Unit of a period. This field is used when type is set to FIXED_RATE. It is used together with fixed_rate to indicate a fixed period.
+The value can be hour or minute.
++
+Table 7 Topics Parameter
+Type
+Description
+name
+String
+Topic name.
+topic_urn
+String
+Specifies the resource identifier of the topic, which is unique.
+display_name
+String
+Specifies the topic display name, which is presented as the name of the email sender in email messages.
+push_policy
+Integer
+Specifies the message push policy.
+Status code: 500
+ ++
+Table 8 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Querying a keyword alarm rule
+GET https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule + +/v2/{project_id}/lts/alarms/keywords-alarm-rule++Example Responses
Status code: 200
+The request is successful.
+{ + "keywords_alarm_rules" : [ { + "alarm_action_rule_name" : "Alarm Action Rule Name", + "alarm_rule_alias" : "APITest", + "condition_expressions" : [ { + "alarm_level" : "CRITICAL", + "condition_expression" : "Matching Log Events>1" + } ], + "create_time" : 1736498043489, + "domain_id" : "78ac2cb7c0be4d0482bd7d949830e0b8", + "frequency" : { + "cron_expr" : "", + "day_of_week" : 1, + "fixed_rate" : 1, + "fixed_rate_unit" : "minute", + "hour_of_day" : 0, + "type" : "FIXED_RATE" + }, + "keywords_alarm_level" : "CRITICAL", + "id" : "025a5375-c548-498c-8330-219cf8a1dbbf", + "indexId" : "025a5375-c548-498c-8330-219cf8a1dbbf", + "key" : "025a5375-c548-498c-8330-219cf8a1dbbf", + "keywords_alarm_rule_description" : "", + "keywords_alarm_rule_id" : "025a5375-c548-498c-8330-219cf8a1dbbf", + "keywords_alarm_rule_name" : "APITest", + "keywords_alarm_send" : true, + "keywords_requests" : [ { + "condition" : ">", + "conditions" : [ { + "alarm_level" : "CRITICAL", + "condition" : ">", + "number" : 1 + } ], + "eps_id" : "0", + "is_time_range_relative" : true, + "keywords" : "aaa", + "log_group_id" : "b2ead43b-c055-4581-8c13-56af52b6bc13", + "log_group_name" : "lts-group-mwb002", + "log_group_name_alias" : "lts-group-mwb002", + "log_stream_id" : "072795c7-ce92-4ea3-b359-1928d47ab152", + "log_stream_name" : "lts-topic-coredns", + "log_stream_name_alias" : "lts-topic-coredns", + "number" : 1, + "search_time_range" : 5, + "search_time_range_unit" : "minute" + } ], + "language" : "zh-cn", + "notification_frequency" : 0, + "projectId" : "a0a12b069ab4491185d7cf26c3e86ada", + "query_version" : "v2", + "query_version_for_query" : "newVersion", + "recovery_policy" : 3, + "status" : "RUNNING", + "tags" : [ { + "key" : "tagTest", + "value" : "level" + } ], + "topics" : [ ], + "trigger_condition_count" : 1, + "trigger_condition_frequency" : 1, + "update_time" : 1736498043489, + "whether_recovery_policy" : true + }, { + "projectId" : "string", + "keywords_alarm_rule_id" : "string", + "keywords_alarm_rule_name" : "string", + "keywords_alarm_rule_description" : "string", + "condition_expression" : "string", + "keywords_requests" : [ { + "log_stream_id" : "string", + "log_stream_name" : "string", + "log_group_id" : "string", + "log_group_name" : "string", + "keywords" : "string", + "condition" : ">=", + "number" : 1, + "search_time_range" : 0, + "search_time_range_unit" : "minute" + } ], + "frequency" : { + "type" : "CRON", + "cron_expr" : "string", + "hour_of_day" : 0, + "day_of_week" : 0, + "fixed_rate" : 0, + "fixed_rate_unit" : "minute" + }, + "keywords_alarm_level" : "Info", + "keywords_alarm_send" : true, + "domain_id" : "string", + "create_time" : 0, + "update_time" : 0, + "template_name" : "Message template name.", + "status" : "RUNNING", + "trigger_condition_count" : "1", + "trigger_condition_frequency" : "1", + "whether_recovery_policy" : false, + "recovery_policy" : "3", + "notification_frequency" : 5, + "alarm_action_rule_name" : "", + "topics" : [ { + "name" : "string", + "topic_urn" : "string", + "display_name" : "test-smn", + "push_policy" : 0 + } ] + } ] +}+Status code: 500
+The server has received the request but encountered an internal error.
+{ + "error_code" : "LTS.2008", + "error_msg" : "Find Alarm rule failed." +}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+500
+The server has received the request but encountered an internal error.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0084.html b/docs/lts/api-ref/lts_api_0084.html new file mode 100644 index 000000000..b2f425632 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0084.html @@ -0,0 +1,191 @@ + + +++Parent topic: Keyword Alarm Rules+Deleting a Keyword Alarm Rule
+++Function
This API is used to delete a keyword alarm.
++URI
DELETE /v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id}
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
+keywords_alarm_rule_id
+Yes
+String
+Keyword alarm rule ID.
+Minimum: 36
+Maximum: 36
++Request Parameters
++
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++Response Parameters
Status code: 400
+ ++
+Table 3 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 4 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Deleting a keyword alarm by alarm ID
+DELETE https://{endpoint}/v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id} + +/v2/{project_id}/lts/alarms/keywords-alarm-rule/{keywords_alarm_rule_id}++Example Responses
Status code: 200
+The request is successful.
+None
+Status code: 400
+Error response content.
+{ + "error_code" : "LTS.2007", + "error_msg" : "Alarm rule not exist." +}+Status code: 500
+The server has received the request but encountered an internal error.
+{ + "error_code" : "LTS.2002", + "error_msg" : "Failed to update alarm rule." +}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+400
+Error response content.
+500
+The server has received the request but encountered an internal error.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0091.html b/docs/lts/api-ref/lts_api_0091.html new file mode 100644 index 000000000..d218d8798 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0091.html @@ -0,0 +1,646 @@ + + +++Parent topic: Keyword Alarm Rules+Querying the Active or Historical Alarm List
+++Function
This API is used to query the alarm list.
++URI
POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/query
+ ++ +
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
+domain_id
+Yes
+String
+Account ID. For details about how to obtain an account ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++
+Table 2 Query Parameters Parameter
+Mandatory
+Type
+Description
+type
+Yes
+String
+Whether the alarm is an active alarm or a historical alarm.
+marker
+No
+String
+The value is the ID of the last record on the previous page (value of previous_marker or next_marker returned by the previous page).
+Minimum: 0
+Maximum: 1000
+limit
+No
+Integer
+Number of records on each page.
+Minimum: 0
+Maximum: 1000
++Request Parameters
++ +
+Table 3 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++ +
+Table 4 Request body parameters Parameter
+Mandatory
+Type
+Description
+whether_custom_field
+Yes
+Boolean
+Whether to customize the query time segment.
+start_time
+No
+Long
+Start time of a customized time segment (timestamp).
+Minimum: 13
+Maximum: 13
+end_time
+No
+Long
+End time of a customized time segment (timestamp).
+Minimum: 13
+Maximum: 13
+time_range
+No
+String
+Time range specified to query data of the last N minutes when the client time is inconsistent with the server time. It can also be used to accurately query the data of a specified period.
+Examples:
+-1.-1.60 indicates that the data of the latest 60 minutes is queried. This query is based on the server time regardless of the current client time.
+1650852000000.1650852300000.5 indicates the 5 minutes from 10:00:00 to 10:05:00 on April 25, 2022 UTC+08:00.
+Format: startTimeInMillis.endTimeInMillis.durationInMinutes
+Parameter description:
+startTimeInMillis: start time (UTC) of the query, in milliseconds. If this parameter is set to -1, the server calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1,000. For example, -1.1650852300000.5 is equivalent to 1650852000000.1650852300000.5.
+endTimeInMillis: end time (UTC) of the query, in milliseconds. If this parameter is set to -1, the server calculates the end time as follows: startTimeInMillis + durationInMinutes x 60 x 1,000. If the calculated end time is later than the current system time, the current system time is used. For example, 1650852000000.-1.5 is equivalent to 1650852000000.1650852300000.5.
+durationInMinutes: time span, in minutes. The value must be greater than 0, and also greater than or equal to the result of "(endTimeInMillis – startTimeInMillis)/(60 x 1,000) – 1". If both the start time and end time are set to -1, the system sets the end time to the current UTC time (in milliseconds) and calculates the start time as follows: endTimeInMillis – durationInMinutes x 60 x 1,000. For example, -1.-1.60 indicates the latest 60 minutes.
+Constraint: In a single request, the following condition must be met: durationInMinutes x 60/period ≤ 1,440
+
Minimum: 1
+Maximum: 32
+search
+No
+String
+Field specified for fuzzy query, which can be left blank. If the value is not empty, fuzzy match will be performed. The metadata field is mandatory.
+Minimum: 1
+Maximum: 1024
+alarm_level_ids
+No
+Array of strings
+Alarm severity (Critical, Major, Minor, Info).
+NOTE:+alarmLevelIds is a parameter of an earlier version and is currently compatible with this parameter. You are advised to use this parameter.
+alarm_level_ids
+sort
+No
+Sort object
+Sorting order, which can be left blank.
+step
+No
+Integer
+Statistical step. Unit: ms. For example, if the duration is 1 minute, set this parameter to 60000.
++
+Table 5 Sort Parameter
+Mandatory
+Type
+Description
+order_by
+Yes
+Array of strings
+List of sorted fields. Fields in this list are sorted based on the specified order.
+order
+Yes
+String
+Sorting order.
+The value can be:
+asc (ascending order)
+desc (descending order)
+
+Response Parameters
Status code: 200
+ ++ +
+Table 6 Response body parameters Parameter
+Type
+Description
+events
+Array of Events objects
+Alarm information.
+page_info
+PageInfo object
+Pagination details.
++ +
+Table 7 Events Parameter
+Type
+Description
+annotations
+Annotations object
+Alert details.
+metadata
+Metadata object
+Alarm information.
+arrives_at
+Long
+Arrival time (timestamp).
+ends_at
+Long
+Alarm clearance time (timestamp).
+id
+String
+Alarm ID.
+starts_at
+Long
+Alarm generation time (timestamp).
+timeout
+Long
+Time when an alarm is automatically cleared (timestamp).
+type
+String
+Alarm rule type (SQL/keyword).
++ +
+Table 8 Annotations Parameter
+Type
+Description
+message
+String
+Alarm list details.
+log_info
+String
+Log group/stream ID.
+current_value
+String
+Current value.
+old_annotations
+String
+Original data of (SQL/keyword) alarm details.
++ +
+Table 9 Metadata Parameter
+Type
+Description
+event_type
+String
+Alarm type.
+event_id
+String
+Alarm ID.
+event_severity
+String
+Alarm severity.
+event_name
+String
+Alarm name.
+resource_type
+String
+Resource type.
+resource_id
+String
+Log group/stream name.
+resource_provider
+String
+Alarm source.
+lts_alarm_type
+String
+Alarm rule type (SQL/keyword).
++
+Table 10 PageInfo Parameter
+Type
+Description
+next_marker
+String
+Address of the next page. If this parameter is left empty, no data is displayed on the next page.
+previous_marker
+String
+Address of the previous page.
+current_count
+String
+Number of items returned on this page.
+Status code: 400
+ ++
+Table 11 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
+Status code: 500
+ ++
+Table 12 Response body parameters Parameter
+Type
+Description
+error_code
+String
+Error code.
+error_msg
+String
+Error message.
++Example Requests
Querying the active or historical alarm list
+POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/query?type=active_alert + +{ + "whether_custom_field" : false, + "start_time" : 0, + "end_time" : 0, + "time_range" : "30", + "search" : "", + "alarm_level_ids" : [ "Critical", "Major", "Minor", "Info" ], + "sort" : { + "order_by" : [ "starts_at" ], + "order" : "desc" + } +}++Example Responses
Status code: 200
+The request is successful.
+{ + "events" : [ { + "annotations" : { + "current_value" : "{\"pv\":30}", + "log_info" : "[{\"log_group_id\":\"50bcab14-xxxx-xxxx-xxxx-41ae4a6e3401\",\"log_group_name\":\"lts-test-group\",\"log_group_name_alias\":\"lts-test-group\",\"log_stream_id\":\"90727e60-xxxx-xxxx-xxxx-19ba53adcbc5\",\"log_stream_name\":\"lts-test-topic\",\"log_stream_name_alias\":\"lts-test-topic\"}]", + "message" : "{\"alarm_action_rule_name\":\"testlts\",\"alarm_rule_alias\":\"lts001\",\"alarm_rule_id\":\"2ef849e9-afb4-4983-9197-9049c3460b9d\",\"alarm_rule_name\":\"lts001\",\"closed_alarm_time\":0,\"condition_expression\":\"pv > 0\",\"condition_expressions\":[{\"condition_expression\":\"pv > 0\"}],\"create_time\":0,\"domain_id\":\"1d26cc8c86a840e28a4f8dxxxxxxxxxx\",\"frequency\":{\"day_of_week\":1,\"fixed_rate\":1,\"fixed_rate_unit\":\"minute\",\"hour_of_day\":0,\"type\":\"FIXED_RATE\"},\"is_css_sql\":true,\"ltsAlarmInfos\":[{\"conditions\":[],\"is_time_range_relative\":true,\"log_group_id\":\"50bcab14-xxxx-xxxx-xxxx-41ae4a6e3401\",\"log_group_name\":\"lts-test-group\",\"log_group_name_alias\":\"lts-test-group\",\"log_stream_id\":\"90727e60-xxxx-xxxx-xxxx-19ba53adcbc5\",\"log_stream_name\":\"lts-test-topic\",\"log_stream_name_alias\":\"lts-test-topic\",\"search_time_range\":5,\"search_time_range_unit\":\"minute\",\"sql\":\"* | SELECT count(*) as pv\",\"sql_request_title\":\"\"}],\"notification_frequency\":0,\"projectId\":\"\",\"status\":\"RUNNING\",\"topics\":[],\"type\":\"sql\",\"update_time\":0,\"whether_recovery_policy\":false}" + }, + "metadata" : { + "event_type" : "alarm", + "event_id" : "2ef849e9-xxxx-xxxx-xxxx-9049c3460b9d", + "lts_alarm_type" : "search_analysis", + "event_severity" : "Critical", + "resource_type" : "Log group/stream.", + "event_name" : "lts001", + "resource_id" : "lts-test-group/lts-test-topic", + "event_subtype" : "sql", + "resource_provider" : "LTS" + }, + "type" : "search_analysis" + } ] +}+Status code: 400
+Response content.
+{ + "error_code" : "LTS.2005", + "error_msg" : "Find alarm error start_time or end_tim must not be empty." +}+Status code: 500
+Response content.
+{ + "error_code" : "LTS.0010", + "error_msg" : "Internal Server Error" +}++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+400
+Response content.
+500
+Response content.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_0092.html b/docs/lts/api-ref/lts_api_0092.html new file mode 100644 index 000000000..c4bacb375 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0092.html @@ -0,0 +1,278 @@ + + +++Parent topic: Alarm List+Deleting an Active Alarm
+++Function
This API is used to delete an active alarm.
++URI
POST /v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear
+ ++
+Table 1 Path Parameters Parameter
+Mandatory
+Type
+Description
+project_id
+Yes
+String
+Project ID. For details about how to obtain a project ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
+domain_id
+Yes
+String
+Account ID. For details about how to obtain an account ID, see Obtaining the Project ID, Account ID, Log Group ID, and Log Stream ID.
+Minimum: 32
+Maximum: 32
++Request Parameters
++ +
+Table 2 Request header parameters Parameter
+Mandatory
+Type
+Description
+X-Auth-Token
+Yes
+String
+User token obtained from IAM. For details about how to obtain a user token, see Obtaining a User Token.
+Minimum: 1000
+Maximum: 2000
+Content-Type
+Yes
+String
+Set this parameter to application/json;charset=UTF-8.
+Minimum: 30
+Maximum: 30
++ +
+Table 3 Request body parameters Parameter
+Mandatory
+Type
+Description
+events
+Yes
+Array of Event objects
+Topic information.
++ +
+Table 4 Event Parameter
+Mandatory
+Type
+Description
+metadata
+Yes
+Metadata object
+Alarm information.
+Minimum length: 0
+Maximum length: 2048
+starts_at
+Yes
+Long
+Alarm generation time (timestamp).
+Minimum: 0
+Maximum: 32
++
+Table 5 Metadata Parameter
+Mandatory
+Type
+Description
+event_type
+Yes
+String
+Alarm type.
+event_id
+Yes
+String
+Alarm ID.
+event_severity
+Yes
+String
+Alarm severity.
+event_name
+Yes
+String
+Alarm name.
+resource_type
+Yes
+String
+Resource type.
+resource_id
+Yes
+String
+Log group/stream name.
+resource_provider
+Yes
+String
+Alarm source.
+lts_alarm_type
+Yes
+String
+Alarm rule type (SQL/keyword).
++Response Parameters
None
++Example Requests
Deleting an active alarm by alarm ID
+POST https://{endpoint}/v2/{project_id}/{domain_id}/lts/alarms/sql-alarm/clear + +{ + "events" : [ { + "metadata" : { + "event_type" : "alarm", + "event_id" : "1", + "lts_alarm_type" : "keywords/sql", + "resource_type" : "Log group/stream.", + "event_severity" : "Critical", + "resource_id" : "lts-group-demo/lts-topic-demo", + "event_name" : "demo", + "resource_provider" : "LTS" + }, + "starts_at" : 1629947408497 + } ] +}++Example Responses
None
++Status Codes
++
+Status Code
+Description
+200
+The request is successful.
+500
+The server has received the request but encountered an internal error.
++Error Codes
See Error Codes.
+++ diff --git a/docs/lts/api-ref/lts_api_1015.html b/docs/lts/api-ref/lts_api_1015.html new file mode 100644 index 000000000..1242fa57a --- /dev/null +++ b/docs/lts/api-ref/lts_api_1015.html @@ -0,0 +1,24 @@ + + +++Parent topic: Alarm List+Host Group Management
++
+++ diff --git a/docs/lts/api-ref/topic_300000003.html b/docs/lts/api-ref/topic_300000003.html new file mode 100644 index 000000000..377aa558d --- /dev/null +++ b/docs/lts/api-ref/topic_300000003.html @@ -0,0 +1,26 @@ + + +-
+
- Querying Host Information
+
+ - Querying Host Groups
+
+ - Creating a Host Group
+
+ - Deleting a Host Group
+
+ - Modifying a Host Group
+
+
++Parent topic: APIs+Log Management
++
+++ diff --git a/docs/lts/api-ref/topic_300000004.html b/docs/lts/api-ref/topic_300000004.html new file mode 100644 index 000000000..c5f4dcecb --- /dev/null +++ b/docs/lts/api-ref/topic_300000004.html @@ -0,0 +1,24 @@ + + +-
+
- Removing a Resource from Favorites
+
+ - Collecting Traffic Statistics on Top N Log Groups or Log Streams
+
+ - Querying the Log Histogram
+
+ - Adding a Log to Favorites
+
+ - Querying Resources by Time Segment
+
+ - Querying Logs
+
+
++Parent topic: APIs+Log Ingestion
++
+++ diff --git a/docs/lts/api-ref/topic_300000005.html b/docs/lts/api-ref/topic_300000005.html new file mode 100644 index 000000000..304ece604 --- /dev/null +++ b/docs/lts/api-ref/topic_300000005.html @@ -0,0 +1,24 @@ + + +-
+
- Creating a Cross-Account Log Ingestion Configuration
+
+ - Querying Log Ingestion Configurations
+
+ - Creating a Log Ingestion Configuration
+
+ - Deleting Log Ingestion Configurations
+
+ - Modifying a Log Ingestion Configuration
+
+
++Parent topic: APIs+Log Transfer
++
+++ diff --git a/docs/lts/api-ref/topic_300000006.html b/docs/lts/api-ref/topic_300000006.html new file mode 100644 index 000000000..567238b75 --- /dev/null +++ b/docs/lts/api-ref/topic_300000006.html @@ -0,0 +1,18 @@ + + +-
+
- Creating a Log Transfer Task (Old Version)
+
+ - Creating a Log Transfer Task (New Version)
+
+ - Deleting a Log Transfer Task
+
+ - Updating a Log Transfer Task
+
+ - Querying a Log Transfer Task
+
+
++Parent topic: APIs+Log Collection Beyond Free Quota
++
++ + ++ diff --git a/docs/lts/api-ref/topic_300000007.html b/docs/lts/api-ref/topic_300000007.html new file mode 100644 index 000000000..57e1ac928 --- /dev/null +++ b/docs/lts/api-ref/topic_300000007.html @@ -0,0 +1,26 @@ + + +++Parent topic: APIs+Cloud Structuring
++
+++ diff --git a/docs/lts/api-ref/topic_300000008.html b/docs/lts/api-ref/topic_300000008.html new file mode 100644 index 000000000..3756c396d --- /dev/null +++ b/docs/lts/api-ref/topic_300000008.html @@ -0,0 +1,16 @@ + + +-
+
- Creating Structuring Configurations (Recommended)
+
+ - Modifying Structuring Configurations (Recommended)
+
+ - Deleting a Structuring Rule
+
+ - Querying a Structuring Rule
+
+ - Querying the Brief List of Structuring Templates
+
+ - Querying a Structuring Template
+
+
++Parent topic: APIs+Alarm Topics
++
++ + ++ diff --git a/docs/lts/api-ref/topic_300000009.html b/docs/lts/api-ref/topic_300000009.html new file mode 100644 index 000000000..c5e9a6166 --- /dev/null +++ b/docs/lts/api-ref/topic_300000009.html @@ -0,0 +1,26 @@ + + +++Parent topic: APIs+Message Template Management
++
+++ diff --git a/docs/lts/api-ref/topic_300000010.html b/docs/lts/api-ref/topic_300000010.html new file mode 100644 index 000000000..3e25b2422 --- /dev/null +++ b/docs/lts/api-ref/topic_300000010.html @@ -0,0 +1,22 @@ + + +-
+
- Creating a Message Template
+
+ - Modifying a Message Template
+
+ - Querying Message Templates
+
+ - Deleting a Message Template
+
+ - Querying a Message Template
+
+ - Previewing the Email Format of a Message Template
+
+
++Parent topic: APIs+Keyword Alarm Rules
++
+++ diff --git a/docs/lts/api-ref/topic_300000011.html b/docs/lts/api-ref/topic_300000011.html new file mode 100644 index 000000000..c6da5f522 --- /dev/null +++ b/docs/lts/api-ref/topic_300000011.html @@ -0,0 +1,18 @@ + + +-
+
- Creating a Keyword Alarm Rule
+
+ - Modifying a Keyword Alarm Rule
+
+ - Querying a Keyword Alarm Rule
+
+ - Deleting a Keyword Alarm Rule
+
+
++Parent topic: APIs+Alarm List
++
++ + ++ diff --git a/docs/lts/api-ref/topic_300000012.html b/docs/lts/api-ref/topic_300000012.html new file mode 100644 index 000000000..480b8d487 --- /dev/null +++ b/docs/lts/api-ref/topic_300000012.html @@ -0,0 +1,16 @@ + + +++Parent topic: APIs+Tag Management
++
+++ diff --git a/docs/lts/api-ref/topic_300000013.html b/docs/lts/api-ref/topic_300000013.html new file mode 100644 index 000000000..013338b38 --- /dev/null +++ b/docs/lts/api-ref/topic_300000013.html @@ -0,0 +1,22 @@ + + +-
+
- Tag Management
+
+
++Parent topic: APIs+Quick Search
++
+++-
+
- Adding a Quick Search
+
+ - Obtaining a Quick Search
+
+ - Deleting a Quick Search
+
+ - Querying All Quick Searches in a Log Group
+
+
++Parent topic: APIs+
- Parameter description
+
- Parameter description
-
- Response parameters
+
- Response parameters
-
- Parameter description
+
- Parameter description
-
- Response parameters
+
- Request parameters
+
- Request parameters
-
- Parameter description
+
- Parameter description
-
- Parameter description
+
- Parameter description
-
- Response parameters
+
- Response parameters
-
- Parameter description
+
- Parameter description
-
- Response parameters
+
- Request parameters
+
- Request parameters
-
- Parameter description
+
- Parameter description
-
