diff --git a/docs/lts/api-ref/.placeholder b/docs/lts/api-ref/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/lts/api-ref/ALL_META.TXT.json b/docs/lts/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..05a66dc4 --- /dev/null +++ b/docs/lts/api-ref/ALL_META.TXT.json @@ -0,0 +1,302 @@ +[ + { + "uri":"lts_02_0001.html", + "product_code":"lts", + "code":"1", + "des":"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 ", + "doc_type":"api", + "kw":"API Description,API Reference", + "title":"API Description", + "githuburl":"" + }, + { + "uri":"lts_02_0002.html", + "product_code":"lts", + "code":"2", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Group Management (Old Version)", + "title":"Log Group Management (Old Version)", + "githuburl":"" + }, + { + "uri":"lts_02_0003.html", + "product_code":"lts", + "code":"3", + "des":"This API is used to create a log group. All API URLs described in this section must be case-sensitive.This function describes how to create a log group for log storage an", + "doc_type":"api", + "kw":"Creating a Log Group,Log Group Management (Old Version),API Reference", + "title":"Creating a Log Group", + "githuburl":"" + }, + { + "uri":"lts_02_0004.html", + "product_code":"lts", + "code":"4", + "des":"This function describes how to query a log group you have created to obtain its name, ID, expiration time, and creation time.URI formatGET /v2.0/{project_id}/log-groups/{", + "doc_type":"api", + "kw":"Querying a Log Group,Log Group Management (Old Version),API Reference", + "title":"Querying a Log Group", + "githuburl":"" + }, + { + "uri":"lts_02_0005.html", + "product_code":"lts", + "code":"5", + "des":"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 grou", + "doc_type":"api", + "kw":"Deleting a Log Group,Log Group Management (Old Version),API Reference", + "title":"Deleting a Log Group", + "githuburl":"" + }, + { + "uri":"lts_api_0011.html", + "product_code":"lts", + "code":"6", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Group Management (New Version)", + "title":"Log Group Management (New Version)", + "githuburl":"" + }, + { + "uri":"lts_api_0012.html", + "product_code":"lts", + "code":"7", + "des":"This API is used to create a log group for log retention and query. You can create a maximum of 100 log groups.POST /v2/{project_id}/groupsURI parameterParameterMandatory", + "doc_type":"api", + "kw":"Creating a Log Group,Log Group Management (New Version),API Reference", + "title":"Creating a Log Group", + "githuburl":"" + }, + { + "uri":"lts_api_0013.html", + "product_code":"lts", + "code":"8", + "des":"This API is used to query all log groups of an account.GET /v2/{project_id}/groupsStatus code: 200Status code: 401Status code: 403Status code: 500Status code: 200Status c", + "doc_type":"api", + "kw":"Querying All Log Groups of an Account,Log Group Management (New Version),API Reference", + "title":"Querying All Log Groups of an Account", + "githuburl":"" + }, + { + "uri":"lts_api_0024.html", + "product_code":"lts", + "code":"9", + "des":"This API is used to modify the log retention duration of a specified log group.POST /v2/{project_id}/groups/{log_group_id}Status code: 200Status code: 400Status code: 401", + "doc_type":"api", + "kw":"Modifying a Log Group,Log Group Management (New Version),API Reference", + "title":"Modifying a Log Group", + "githuburl":"" + }, + { + "uri":"lts_api_0014.html", + "product_code":"lts", + "code":"10", + "des":"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.DELET", + "doc_type":"api", + "kw":"Deleting a Log Group,Log Group Management (New Version),API Reference", + "title":"Deleting a Log Group", + "githuburl":"" + }, + { + "uri":"lts_02_0006.html", + "product_code":"lts", + "code":"11", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Stream Management (Old Version)", + "title":"Log Stream Management (Old Version)", + "githuburl":"" + }, + { + "uri":"lts_02_0007.html", + "product_code":"lts", + "code":"12", + "des":"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 formatPOST /v2.0/{project_id}/log-gro", + "doc_type":"api", + "kw":"Creating a Log Stream,Log Stream Management (Old Version),API Reference", + "title":"Creating a Log Stream", + "githuburl":"" + }, + { + "uri":"lts_02_0008.html", + "product_code":"lts", + "code":"13", + "des":"This function describes how to query a log stream you have created to obtain its name, ID, expiration time, and creation time.URI formatGET /v2.0/{project_id}/log-groups/", + "doc_type":"api", + "kw":"Querying a Log Stream,Log Stream Management (Old Version),API Reference", + "title":"Querying a Log Stream", + "githuburl":"" + }, + { + "uri":"lts_02_0009.html", + "product_code":"lts", + "code":"14", + "des":"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 s", + "doc_type":"api", + "kw":"Deleting a log stream,Log Stream Management (Old Version),API Reference", + "title":"Deleting a log stream", + "githuburl":"" + }, + { + "uri":"lts_api_0015.html", + "product_code":"lts", + "code":"15", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Stream Management (New Version)", + "title":"Log Stream Management (New Version)", + "githuburl":"" + }, + { + "uri":"lts_api_0016.html", + "product_code":"lts", + "code":"16", + "des":"This API is used to create a log stream in a specified log group.POST /v2/{project_id}/groups/{log_group_id}/streamsStatus code: 201Status code: 400Status code: 401Status", + "doc_type":"api", + "kw":"Creating a Log Stream,Log Stream Management (New Version),API Reference", + "title":"Creating a Log Stream", + "githuburl":"" + }, + { + "uri":"lts_api_0017.html", + "product_code":"lts", + "code":"17", + "des":"This API is used to query information about all log streams in a specified log group.GET /v2/{project_id}/groups/{log_group_id}/streamsStatus code: 200Status code: 401Sta", + "doc_type":"api", + "kw":"Querying All Log Streams in a Specified Log Group,Log Stream Management (New Version),API Reference", + "title":"Querying All Log Streams in a Specified Log Group", + "githuburl":"" + }, + { + "uri":"lts_api_0018.html", + "product_code":"lts", + "code":"18", + "des":"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.DELETE", + "doc_type":"api", + "kw":"Deleting a Log Stream,Log Stream Management (New Version),API Reference", + "title":"Deleting a Log Stream", + "githuburl":"" + }, + { + "uri":"lts_api_0029.html", + "product_code":"lts", + "code":"19", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Management", + "title":"Log Management", + "githuburl":"" + }, + { + "uri":"lts_api_0028.html", + "product_code":"lts", + "code":"20", + "des":"This API is used to query logs in a specified log stream.POST /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/queryStatus code: 200Status code: 400", + "doc_type":"api", + "kw":"Querying Logs,Log Management,API Reference", + "title":"Querying Logs", + "githuburl":"" + }, + { + "uri":"lts_api_0026.html", + "product_code":"lts", + "code":"21", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Log Transfer", + "title":"Log Transfer", + "githuburl":"" + }, + { + "uri":"lts_api_0027.html", + "product_code":"lts", + "code":"22", + "des":"This API is used to transfer logs of one or more specified log streams to Object Storage Service (OBS).POST /v2/{project_id}/log-dump/obsStatus code: 201Status code: 400S", + "doc_type":"api", + "kw":"Creating a Log Transfer Task,Log Transfer,API Reference", + "title":"Creating a Log Transfer Task", + "githuburl":"" + }, + { + "uri":"lts_api_0030.html", + "product_code":"", + "code":"23", + "des":"This API is used to delete an OBS transfer task.DELETE /v2/{project_id}/transfersStatus code: 200Status code: 400Status code: 500Deleting a log transfer task based on the", + "doc_type":"", + "kw":"Deleting a Log Transfer Task,Log Transfer,API Reference", + "title":"Deleting a Log Transfer Task", + "githuburl":"" + }, + { + "uri":"lts_api_0031.html", + "product_code":"", + "code":"24", + "des":"This API is used to update an OBS transfer task.PUT /v2/{project_id}/transfersStatus code: 200Status code: 400Status code: 500Updating an OBS transfer taskPUT https://{en", + "doc_type":"", + "kw":"Updating a Log Transfer Task,Log Transfer,API Reference", + "title":"Updating a Log Transfer Task", + "githuburl":"" + }, + { + "uri":"lts_api_0032.html", + "product_code":"", + "code":"25", + "des":"This API is used to query an OBS transfer task.GET /v2/{project_id}/transfersStatus code: 200Status code: 400Status code: 500If no parameter is specified, all log transfe", + "doc_type":"", + "kw":"Querying a Log Transfer Task,Log Transfer,API Reference", + "title":"Querying a Log Transfer Task", + "githuburl":"" + }, + { + "uri":"lts_02_0019.html", + "product_code":"lts", + "code":"26", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Public Parameters", + "title":"Public Parameters", + "githuburl":"" + }, + { + "uri":"lts_02_0020.html", + "product_code":"lts", + "code":"27", + "des":"Table 1 lists the status code.", + "doc_type":"api", + "kw":"Status Code,Public Parameters,API Reference", + "title":"Status Code", + "githuburl":"" + }, + { + "uri":"lts_02_0021.html", + "product_code":"lts", + "code":"28", + "des":"This section explains the meanings of error code responses returned by LTS APIs.{\"error_msg\":\"Current user is not authenticated correctly, check your token.\",\"error_code\"", + "doc_type":"api", + "kw":"Error Code,Public Parameters,API Reference", + "title":"Error Code", + "githuburl":"" + }, + { + "uri":"lts_api_0006.html", + "product_code":"lts", + "code":"29", + "des":"Account and project IDs are required in URLs when you call some APIs.Obtain the IDs from the console.Log in to the LTS console.On the Log Management page, obtain the log ", + "doc_type":"api", + "kw":"Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID,Public Parameters,API Reference", + "title":"Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID", + "githuburl":"" + }, + { + "uri":"lts_02_0014.html", + "product_code":"lts", + "code":"30", + "des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "doc_type":"api", + "kw":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/lts/api-ref/CLASS.TXT.json b/docs/lts/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..8e491cbc --- /dev/null +++ b/docs/lts/api-ref/CLASS.TXT.json @@ -0,0 +1,272 @@ +[ + { + "desc":"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 ", + "product_code":"lts", + "title":"API Description", + "uri":"lts_02_0001.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Log Group Management (Old Version)", + "uri":"lts_02_0002.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "desc":"This API is used to create a log group. All API URLs described in this section must be case-sensitive.This function describes how to create a log group for log storage an", + "product_code":"lts", + "title":"Creating a Log Group", + "uri":"lts_02_0003.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This function describes how to query a log group you have created to obtain its name, ID, expiration time, and creation time.URI formatGET /v2.0/{project_id}/log-groups/{", + "product_code":"lts", + "title":"Querying a Log Group", + "uri":"lts_02_0004.html", + "doc_type":"api", + "p_code":"2", + "code":"4" + }, + { + "desc":"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 grou", + "product_code":"lts", + "title":"Deleting a Log Group", + "uri":"lts_02_0005.html", + "doc_type":"api", + "p_code":"2", + "code":"5" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Log Group Management (New Version)", + "uri":"lts_api_0011.html", + "doc_type":"api", + "p_code":"", + "code":"6" + }, + { + "desc":"This API is used to create a log group for log retention and query. You can create a maximum of 100 log groups.POST /v2/{project_id}/groupsURI parameterParameterMandatory", + "product_code":"lts", + "title":"Creating a Log Group", + "uri":"lts_api_0012.html", + "doc_type":"api", + "p_code":"6", + "code":"7" + }, + { + "desc":"This API is used to query all log groups of an account.GET /v2/{project_id}/groupsStatus code: 200Status code: 401Status code: 403Status code: 500Status code: 200Status c", + "product_code":"lts", + "title":"Querying All Log Groups of an Account", + "uri":"lts_api_0013.html", + "doc_type":"api", + "p_code":"6", + "code":"8" + }, + { + "desc":"This API is used to modify the log retention duration of a specified log group.POST /v2/{project_id}/groups/{log_group_id}Status code: 200Status code: 400Status code: 401", + "product_code":"lts", + "title":"Modifying a Log Group", + "uri":"lts_api_0024.html", + "doc_type":"api", + "p_code":"6", + "code":"9" + }, + { + "desc":"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.DELET", + "product_code":"lts", + "title":"Deleting a Log Group", + "uri":"lts_api_0014.html", + "doc_type":"api", + "p_code":"6", + "code":"10" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Log Stream Management (Old Version)", + "uri":"lts_02_0006.html", + "doc_type":"api", + "p_code":"", + "code":"11" + }, + { + "desc":"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 formatPOST /v2.0/{project_id}/log-gro", + "product_code":"lts", + "title":"Creating a Log Stream", + "uri":"lts_02_0007.html", + "doc_type":"api", + "p_code":"11", + "code":"12" + }, + { + "desc":"This function describes how to query a log stream you have created to obtain its name, ID, expiration time, and creation time.URI formatGET /v2.0/{project_id}/log-groups/", + "product_code":"lts", + "title":"Querying a Log Stream", + "uri":"lts_02_0008.html", + "doc_type":"api", + "p_code":"11", + "code":"13" + }, + { + "desc":"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 s", + "product_code":"lts", + "title":"Deleting a log stream", + "uri":"lts_02_0009.html", + "doc_type":"api", + "p_code":"11", + "code":"14" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Log Stream Management (New Version)", + "uri":"lts_api_0015.html", + "doc_type":"api", + "p_code":"", + "code":"15" + }, + { + "desc":"This API is used to create a log stream in a specified log group.POST /v2/{project_id}/groups/{log_group_id}/streamsStatus code: 201Status code: 400Status code: 401Status", + "product_code":"lts", + "title":"Creating a Log Stream", + "uri":"lts_api_0016.html", + "doc_type":"api", + "p_code":"15", + "code":"16" + }, + { + "desc":"This API is used to query information about all log streams in a specified log group.GET /v2/{project_id}/groups/{log_group_id}/streamsStatus code: 200Status code: 401Sta", + "product_code":"lts", + "title":"Querying All Log Streams in a Specified Log Group", + "uri":"lts_api_0017.html", + "doc_type":"api", + "p_code":"15", + "code":"17" + }, + { + "desc":"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.DELETE", + "product_code":"lts", + "title":"Deleting a Log Stream", + "uri":"lts_api_0018.html", + "doc_type":"api", + "p_code":"15", + "code":"18" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Log Management", + "uri":"lts_api_0029.html", + "doc_type":"api", + "p_code":"", + "code":"19" + }, + { + "desc":"This API is used to query logs in a specified log stream.POST /v2/{project_id}/groups/{log_group_id}/streams/{log_stream_id}/content/queryStatus code: 200Status code: 400", + "product_code":"lts", + "title":"Querying Logs", + "uri":"lts_api_0028.html", + "doc_type":"api", + "p_code":"19", + "code":"20" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Log Transfer", + "uri":"lts_api_0026.html", + "doc_type":"api", + "p_code":"", + "code":"21" + }, + { + "desc":"This API is used to transfer logs of one or more specified log streams to Object Storage Service (OBS).POST /v2/{project_id}/log-dump/obsStatus code: 201Status code: 400S", + "product_code":"lts", + "title":"Creating a Log Transfer Task", + "uri":"lts_api_0027.html", + "doc_type":"api", + "p_code":"21", + "code":"22" + }, + { + "desc":"This API is used to delete an OBS transfer task.DELETE /v2/{project_id}/transfersStatus code: 200Status code: 400Status code: 500Deleting a log transfer task based on the", + "product_code":"lts", + "title":"Deleting a Log Transfer Task", + "uri":"lts_api_0030.html", + "doc_type":"api", + "p_code":"21", + "code":"23" + }, + { + "desc":"This API is used to update an OBS transfer task.PUT /v2/{project_id}/transfersStatus code: 200Status code: 400Status code: 500Updating an OBS transfer taskPUT https://{en", + "product_code":"lts", + "title":"Updating a Log Transfer Task", + "uri":"lts_api_0031.html", + "doc_type":"api", + "p_code":"21", + "code":"24" + }, + { + "desc":"This API is used to query an OBS transfer task.GET /v2/{project_id}/transfersStatus code: 200Status code: 400Status code: 500If no parameter is specified, all log transfe", + "product_code":"lts", + "title":"Querying a Log Transfer Task", + "uri":"lts_api_0032.html", + "doc_type":"api", + "p_code":"21", + "code":"25" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Public Parameters", + "uri":"lts_02_0019.html", + "doc_type":"api", + "p_code":"", + "code":"26" + }, + { + "desc":"Table 1 lists the status code.", + "product_code":"lts", + "title":"Status Code", + "uri":"lts_02_0020.html", + "doc_type":"api", + "p_code":"26", + "code":"27" + }, + { + "desc":"This section explains the meanings of error code responses returned by LTS APIs.{\"error_msg\":\"Current user is not authenticated correctly, check your token.\",\"error_code\"", + "product_code":"lts", + "title":"Error Code", + "uri":"lts_02_0021.html", + "doc_type":"api", + "p_code":"26", + "code":"28" + }, + { + "desc":"Account and project IDs are required in URLs when you call some APIs.Obtain the IDs from the console.Log in to the LTS console.On the Log Management page, obtain the log ", + "product_code":"lts", + "title":"Obtaining the AccountID, Project ID, Log Group ID, and Log Stream ID", + "uri":"lts_api_0006.html", + "doc_type":"api", + "p_code":"26", + "code":"29" + }, + { + "desc":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.", + "product_code":"lts", + "title":"Change History", + "uri":"lts_02_0014.html", + "doc_type":"api", + "p_code":"", + "code":"30" + } +] \ No newline at end of file diff --git a/docs/lts/api-ref/PARAMETERS.txt b/docs/lts/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/lts/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/lts/api-ref/lts_02_0001.html b/docs/lts/api-ref/lts_02_0001.html new file mode 100644 index 00000000..33930810 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0001.html @@ -0,0 +1,8 @@ + + +

API Description

+

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.

+
+ diff --git a/docs/lts/api-ref/lts_02_0002.html b/docs/lts/api-ref/lts_02_0002.html new file mode 100644 index 00000000..c7a40b46 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0002.html @@ -0,0 +1,15 @@ + + +

Log Group Management (Old Version)

+
+
+ +
+ diff --git a/docs/lts/api-ref/lts_02_0003.html b/docs/lts/api-ref/lts_02_0003.html new file mode 100644 index 00000000..d283ec6c --- /dev/null +++ b/docs/lts/api-ref/lts_02_0003.html @@ -0,0 +1,122 @@ + + +

Creating a Log Group

+

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

+ +
+

Request

+ +
+

Response

+ +
+

Returned Value

+ +
+
+
+
+
Parent topic: Log Group Management (Old Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0004.html b/docs/lts/api-ref/lts_02_0004.html new file mode 100644 index 00000000..c8037793 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0004.html @@ -0,0 +1,114 @@ + + +

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.

+
+

URI

+ +
+

Request

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: Log Group Management (Old Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0005.html b/docs/lts/api-ref/lts_02_0005.html new file mode 100644 index 00000000..3d6c1893 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0005.html @@ -0,0 +1,62 @@ + + +

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.

+
+
+

URI

+ +
+

Request

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: Log Group Management (Old Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0006.html b/docs/lts/api-ref/lts_02_0006.html new file mode 100644 index 00000000..bdae7388 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0006.html @@ -0,0 +1,15 @@ + + +

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 new file mode 100644 index 00000000..e7cbb041 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0007.html @@ -0,0 +1,110 @@ + + +

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.

+
+

URI

+ +
+

Request

+ +
+

Response

+ +
+

Returned Value

+
+
+
+
+
Parent topic: Log Stream Management (Old Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0008.html b/docs/lts/api-ref/lts_02_0008.html new file mode 100644 index 00000000..5fe00681 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0008.html @@ -0,0 +1,113 @@ + + +

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.

+
+

URI

+ +
+

Request

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: Log Stream Management (Old Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0009.html b/docs/lts/api-ref/lts_02_0009.html new file mode 100644 index 00000000..c714e210 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0009.html @@ -0,0 +1,71 @@ + + +

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.

+
+
+

URI

+ +
+

Request

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: Log Stream Management (Old Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0014.html b/docs/lts/api-ref/lts_02_0014.html new file mode 100644 index 00000000..e48af53f --- /dev/null +++ b/docs/lts/api-ref/lts_02_0014.html @@ -0,0 +1,43 @@ + + +

Change History

+
+
+ + + + + + + + + + + + + + + + + + + +

Released On

+

Description

+

2022-10-30

+

Modified as follows:

+
  1. Added section Log Group Management (New Version).
  2. Added section Log Stream Management (New Version).
  3. Added section Log Management.
  4. 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

+
  1. Changed the Endpoint URL of LTS from https://Endpoint/uri to https://lts.eu-de.otc.t-systems.com/uri.
  2. Changed Ttl_in_days to ttl_in_days in the response parameter description table in Querying a Log Group.
  3. 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.

+
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0019.html b/docs/lts/api-ref/lts_02_0019.html new file mode 100644 index 00000000..ca7e40d6 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0019.html @@ -0,0 +1,15 @@ + + +

Public Parameters

+
+
+ +
+ diff --git a/docs/lts/api-ref/lts_02_0020.html b/docs/lts/api-ref/lts_02_0020.html new file mode 100644 index 00000000..0ea35c73 --- /dev/null +++ b/docs/lts/api-ref/lts_02_0020.html @@ -0,0 +1,100 @@ + + +

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.

+
+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/lts/api-ref/lts_02_0021.html b/docs/lts/api-ref/lts_02_0021.html new file mode 100644 index 00000000..c6a99a1d --- /dev/null +++ b/docs/lts/api-ref/lts_02_0021.html @@ -0,0 +1,199 @@ + + +

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.

+
+
+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0006.html b/docs/lts/api-ref/lts_api_0006.html new file mode 100644 index 00000000..b6900de1 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0006.html @@ -0,0 +1,16 @@ + + +

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 Log Group and Log Stream IDs

+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0011.html b/docs/lts/api-ref/lts_api_0011.html new file mode 100644 index 00000000..fc0399be --- /dev/null +++ b/docs/lts/api-ref/lts_api_0011.html @@ -0,0 +1,17 @@ + + +

Log Group Management (New Version)

+
+
+ +
+ diff --git a/docs/lts/api-ref/lts_api_0012.html b/docs/lts/api-ref/lts_api_0012.html new file mode 100644 index 00000000..81261f9f --- /dev/null +++ b/docs/lts/api-ref/lts_api_0012.html @@ -0,0 +1,370 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Group Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0013.html b/docs/lts/api-ref/lts_api_0013.html new file mode 100644 index 00000000..a8a7850e --- /dev/null +++ b/docs/lts/api-ref/lts_api_0013.html @@ -0,0 +1,304 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Group Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0014.html b/docs/lts/api-ref/lts_api_0014.html new file mode 100644 index 00000000..9c857774 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0014.html @@ -0,0 +1,285 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Group Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0015.html b/docs/lts/api-ref/lts_api_0015.html new file mode 100644 index 00000000..48510c96 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0015.html @@ -0,0 +1,15 @@ + + +

Log Stream Management (New Version)

+
+
+ +
+ diff --git a/docs/lts/api-ref/lts_api_0016.html b/docs/lts/api-ref/lts_api_0016.html new file mode 100644 index 00000000..c56e945e --- /dev/null +++ b/docs/lts/api-ref/lts_api_0016.html @@ -0,0 +1,363 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Stream Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0017.html b/docs/lts/api-ref/lts_api_0017.html new file mode 100644 index 00000000..531fdd70 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0017.html @@ -0,0 +1,345 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Stream Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0018.html b/docs/lts/api-ref/lts_api_0018.html new file mode 100644 index 00000000..ca78493c --- /dev/null +++ b/docs/lts/api-ref/lts_api_0018.html @@ -0,0 +1,316 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Stream Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0024.html b/docs/lts/api-ref/lts_api_0024.html new file mode 100644 index 00000000..eb018059 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0024.html @@ -0,0 +1,358 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Group Management (New Version)
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0026.html b/docs/lts/api-ref/lts_api_0026.html new file mode 100644 index 00000000..5ddfaa5b --- /dev/null +++ b/docs/lts/api-ref/lts_api_0026.html @@ -0,0 +1,17 @@ + + +

Log Transfer

+
+
+ +
+ diff --git a/docs/lts/api-ref/lts_api_0027.html b/docs/lts/api-ref/lts_api_0027.html new file mode 100644 index 00000000..a3b249e3 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0027.html @@ -0,0 +1,449 @@ + + +

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

+ +

Status code: 201

+
{ 
+  "log_dump_obs_id" : "45fdc36b-xxxx-4567-xxxx-559xxxxdf968" 
+}
+

Status code: 400

+ +

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

+ +
+ +

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.

+
+
+
+
+
Parent topic: Log Transfer
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0028.html b/docs/lts/api-ref/lts_api_0028.html new file mode 100644 index 00000000..d0aaded4 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0028.html @@ -0,0 +1,921 @@ + + +

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

+
UTC start time of the search window (in milliseconds).
NOTE:

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
+ +
+ +

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.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.

+
+
+
+
+
Parent topic: Log Management
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0029.html b/docs/lts/api-ref/lts_api_0029.html new file mode 100644 index 00000000..e7b728e3 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0029.html @@ -0,0 +1,11 @@ + + +

Log Management

+
+
+ +
+ diff --git a/docs/lts/api-ref/lts_api_0030.html b/docs/lts/api-ref/lts_api_0030.html new file mode 100644 index 00000000..81c17493 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0030.html @@ -0,0 +1,474 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Transfer
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0031.html b/docs/lts/api-ref/lts_api_0031.html new file mode 100644 index 00000000..8ff7dd79 --- /dev/null +++ b/docs/lts/api-ref/lts_api_0031.html @@ -0,0 +1,661 @@ + + +

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

+
+

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.

+
+
+
+
+
Parent topic: Log Transfer
+
+
+ diff --git a/docs/lts/api-ref/lts_api_0032.html b/docs/lts/api-ref/lts_api_0032.html new file mode 100644 index 00000000..77ce086a --- /dev/null +++ b/docs/lts/api-ref/lts_api_0032.html @@ -0,0 +1,650 @@ + + +

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.

+
+
+
+
+
Parent topic: Log Transfer
+
+
+ diff --git a/docs/lts/api-ref/public_sys-resources/ExpandCollapse.js b/docs/lts/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..116ddaab --- /dev/null +++ b/docs/lts/api-ref/public_sys-resources/ExpandCollapse.js @@ -0,0 +1 @@ +var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d-1){ExpandForHref(a.substring(a.lastIndexOf("#")+1))}}catch(c){}}; \ No newline at end of file diff --git a/docs/lts/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/lts/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/lts/api-ref/public_sys-resources/commonltr.css b/docs/lts/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/lts/api-ref/public_sys-resources/commonltr.css @@ -0,0 +1 @@ +body{font-size:10pt;font-family:Arial;margin:1.5em;border-top:2pt;padding-top:1em;padding-bottom:2em}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:.6em;margin-bottom:.6em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.figcap{font-size:10pt}img{margin-top:.3em}.figdesc{font-style:normal}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.fignone{font-size:10pt;margin-top:8pt;margin-bottom:8pt}.familylinks{margin-top:1.5em;margin-bottom:1em}.ullinks{list-style-type:none}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-top:.6em;margin-bottom:.6em}.reltasks{margin-top:.6em;margin-bottom:.6em}.relref{margin-top:.6em;margin-bottom:.6em}.relinfo{margin-top:.6em;margin-bottom:.6em}.breadcrumb{font-size:smaller;margin-bottom:.6em}.prereq{margin-left:20px}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.topictitle1{margin-top:0;margin-bottom:1em;font-size:14pt;color:#007af4}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;color:#007af4}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;color:#007af4}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold}.topictitle5{font-size:1.17em;font-weight:bold}.topictitle6{font-size:1.17em;font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:1em;color:black;font-size:10.5pt;font-weight:bold;color:#007af4;overflow:auto}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}.sectiontitle2contents:link{color:#007af4}.sectiontitle2contents:visited{color:#800080}.note{margin-top:1em;margin-bottom:1em;background-color:#ffc}.notetitle{font-weight:bold}.notelisttitle{font-weight:bold}.tip{margin-top:1em;margin-bottom:1em;background-color:#ffc}.tiptitle{font-weight:bold}.fastpath{margin-top:1em;margin-bottom:1em;background-color:#ffc}.fastpathtitle{font-weight:bold}.important{margin-top:1em;margin-bottom:1em;background-color:#ffc}.importanttitle{font-weight:bold}.remember{margin-top:1em;margin-bottom:1em;background-color:#ffc}.remembertitle{font-weight:bold}.restriction{margin-top:1em;margin-bottom:1em;background-color:#ffc}.restrictiontitle{font-weight:bold}.attention{margin-top:1em;margin-bottom:1em;background-color:#ffc}.attentiontitle{font-weight:bold}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;background-color:#ffc}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;background-color:#ffc}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;background-color:#ffc}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;background-color:#ffc}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}ol{margin-top:1em;margin-bottom:1em;margin-left:2.4em;padding-left:0}ul{margin-top:1em;margin-bottom:1em;margin-left:2.0em;padding-left:0}ol ul{list-style:disc}ul ul{list-style:square}ol ul ul{list-style:square}ol ul{list-style-type:disc}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}.firstcol{font-weight:bold}th{background-color:#cfcfcf}table{margin-top:8pt;margin-bottom:12pt;width:100%}table caption{margin-top:8pt;text-align:left}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:.3em;margin-bottom:.3em}.substepexpand{margin-top:.3em;margin-bottom:.3em}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;background-color:#ddd;white-space:pre}.hrcopyright{color:#3f4e5d;margin-top:18pt}.hwcopyright{text-align:center}.comment{margin:2px 2px 2px 2px;font-family:Arial;font-size:10pt;background-color:#bfb;color:#000}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowncontext{display:none}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdowncollapsetable{border:0}.dropdowncollapsetable .dropdowncontext{display:none}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}pre{font-size:10pt;font-weight:normal;margin-left:9;margin-top:2;margin-bottom:2}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0} \ No newline at end of file diff --git a/docs/lts/api-ref/public_sys-resources/commonltr_print.css b/docs/lts/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/lts/api-ref/public_sys-resources/commonltr_print.css @@ -0,0 +1 @@ +body{font-size:12.0pt;margin:1.5em;margin-left:1.6cm}.msgph{font-family:Courier New}.rowlinecopyright{color:red;margin-top:10pt}.unresolved{background-color:skyblue}.noTemplate{background-color:yellow}.base{background-color:#fff}.nested0{margin-top:1em}.p{margin-top:1em}p{margin-top:.5em;margin-bottom:.5em}.note p{margin-top:.5em;margin-bottom:.5em}.tip p{margin-top:.5em;margin-bottom:.5em}.danger p{margin-top:.5em;margin-bottom:.5em}.warning p{margin-top:.5em;margin-bottom:.5em}.notice p{margin-top:.5em;margin-bottom:.5em}.caution p{margin-top:.5em;margin-bottom:.5em}.attention p{margin-top:.5em;margin-bottom:.5em}table p{margin-top:.2em;margin-bottom:.2em}table .p{margin-top:.4em;margin-bottom:.2em}.covertable{border:0;width:100% cellpadding:8pt;cellspacing:8pt}.cover_productname{font-size:15.0pt;font-family:"Arial"}.cover_manualtitle{font-size:24.0pt;font-weight:bold;font-family:"Arial"}.cover_manualsubtitle{font-size:18.0pt;font-weight:bold;font-family:"Arial"}.cover_heading{font-size:12.0pt;font-weight:bold;font-family:"Arial"}.cover_text{font-size:9.0pt;font-family:"Arial"}.tocheading,.heading1,.topictitle1{margin-top:40.0pt;margin-right:0;margin-bottom:20.0pt;margin-left:-1cm;text-align:left;border:0;border-bottom:solid windowtext .5pt;font-size:22.0pt;font-family:"Arial";font-weight:bold}.topictitlenumber1{font-size:72.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle2{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Arial";font-weight:bold}.topictitle3{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:16.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle4{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:14.0pt;font-family:"Book Antiqua";font-weight:bold}.topictitle5{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.blocklabel,.topictitle6{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.sectiontitle{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:-1cm;text-indent:0;font-size:13.0pt;font-family:"Arial";font-weight:bold}.tocentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Book Antiqua";font-weight:bold}.tocentry2{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry3{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry4{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tocentry5{margin-top:4.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman"}.tofentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.totentry1{margin-top:8.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;line-height:12.0pt;font-size:11.0pt;font-family:"Times New Roman";font-weight:normal}.indexheading{margin-top:15.0pt;margin-right:0;margin-bottom:4.0pt;margin-left:0;text-indent:0;font-size:13.0pt;font-family:"Book Antiqua";font-weight:bold}.indexentry1{margin-top:4pt;margin-right:0;margin-bottom:0;margin-left:0;line-height:12.0pt;font-size:12.0pt;font-family:"Times New Roman"}.indexentry2{margin-top:0;margin-right:0;margin-bottom:0;margin-left:24.0pt;line-height:12.0pt;font-size:12.0pt}.indexentry3{margin-top:0;margin-right:0;margin-bottom:0;margin-left:48pt;line-height:12.0pt;font-size:12.0pt}.figurenumber{font-weight:bold}.tablenumber{font-weight:bold}.familylinks{margin-top:1.5em;margin-bottom:1em}.figcap{font-size:11.0pt}.tablecap{font-size:11.0pt}.figdesc{font-style:normal}.fignone{margin-top:8.0pt}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver}.figbottom{border-bottom:2px solid;border-color:Silver}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver}.ullinks{margin-left:0;list-style-type:none}.ulchildlink{margin-top:1em;margin-bottom:1em}.olchildlink{margin-top:1em;margin-bottom:1em;margin-left:1em}.linklist{margin-bottom:1em}.linklistwithchild{margin-left:1.5em;margin-bottom:1em}.sublinklist{margin-left:1.5em;margin-bottom:1em}.relconcepts{margin-left:1cm;margin-top:1em;margin-bottom:1em}.reltasks{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relref{margin-left:1cm;margin-top:1em;margin-bottom:1em}.relinfo{margin-top:1em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-left:0}.parentlink{margin-top:.6em;margin-bottom:.6em}.nextlink{margin-top:.6em;margin-bottom:.6em}.previouslink{margin-top:.6em;margin-bottom:.6em}.section{margin-top:1em;margin-bottom:1em}.example{margin-top:1em;margin-bottom:1em}table .note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.note{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.notetitle{font-weight:bold;font-size:11.0pt}.notelisttitle{font-weight:bold}table .tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.tip{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.tiptitle{font-weight:bold;font-size:11.0pt}table .fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.fastpath{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.fastpathtitle{font-weight:bold;font-size:11.0pt}table .important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.important{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.importanttitle{font-weight:bold;font-size:11.0pt}table .remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.remember{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.remembertitle{font-weight:bold;font-size:11.0pt}table .restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman";font-style:italic}.restriction{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;border-top:solid .5pt;border-bottom:solid .5pt}.restrictiontitle{font-weight:bold;font-size:11.0pt}table .attention{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.attention{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}.attentiontitle{font-weight:bold}table .danger{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.dangertitle{font-weight:bold}.danger{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .notice{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.noticetitle{font-weight:bold}.notice{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .warning{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}.warningtitle{font-weight:bold}.warning{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}table .caution{margin-top:1em;margin-bottom:1em;border:0;font-size:10.0pt;font-family:"Times New Roman"}table caption{margin-top:8pt;text-align:left;font-weight:bold}.tablenoborder{margin-top:8pt}.cautiontitle{font-weight:bold}.caution{margin-top:1em;margin-bottom:1em;border:0;border-top:solid .5pt;border-bottom:solid .5pt}ul.simple{list-style-type:none}li ul{margin-top:.6em}li{margin-top:.6em;margin-bottom:.6em}.note li{margin-top:.2em;margin-bottom:.2em}.tip li{margin-top:.2em;margin-bottom:.2em}.danger li{margin-top:.2em;margin-bottom:.2em}.warning li{margin-top:.2em;margin-bottom:.2em}.notice li{margin-top:.2em;margin-bottom:.2em}.caution li{margin-top:.2em;margin-bottom:.2em}.attention li{margin-top:.2em;margin-bottom:.2em}table li{margin-top:.2em;margin-bottom:.2em}.firstcol{font-weight:bold}th{background-color:#cfcfcf}.bold{font-weight:bold}.boldItalic{font-weight:bold;font-style:italic}.italic{font-style:italic}.underlined{text-decoration:underline}.var{font-style:italic}.shortcut{text-decoration:underline}.dlterm{font-weight:bold}dd{margin-top:.5em;margin-bottom:.5em}.dltermexpand{font-weight:bold;margin-top:1em}*[compact="yes"]>li{margin-top:0}*[compact="no"]>li{margin-top:.53em}.liexpand{margin-top:1em;margin-bottom:1em}.sliexpand{margin-top:1em;margin-bottom:1em}.dlexpand{margin-top:1em;margin-bottom:1em}.ddexpand{margin-top:1em;margin-bottom:1em}.stepexpand{margin-top:1em;margin-bottom:1em}.substepexpand{margin-top:1em;margin-bottom:1em}table{margin-top:8pt;margin-bottom:10.0pt;width:100%}thead{font-size:10.0pt;font-family:"Book Antiqua";font-weight:bold}tbody{font-size:11.0pt}ol{margin-top:1em;margin-bottom:1em;margin-left:1.7em;-webkit-padding-start:0}ul{margin-top:1em;margin-bottom:1em;margin-left:1.2em;-webkit-padding-start:0}ol ul{list-style:disc}ul ul{list-style:square}ol ol{list-style-type:lower-alpha}table ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}table ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ul{margin-top:.4em;margin-bottom:.4em;list-style:square}table ol ol{margin-top:.4em;margin-bottom:.4em;list-style:lower-alpha}table ol ul{margin-top:.4em;margin-bottom:.4em;list-style:disc}table ul ol{margin-top:.4em;margin-bottom:.4em;list-style:decimal}.substepthirdol{list-style-type:lower-roman}div.imageleft{text-align:left}div.imagecenter{text-align:center}div.imageright{text-align:right}div.imagejustify{text-align:justify}div.noblankline{text-align:center}div.noblankline img{margin-top:0}pre{font-size:10.0pt;border-width:2px;padding:2px;margin-top:5px;margin-bottom:5px;white-space:pre-wrap;white-space:-moz-pre-wrap;white-space:-pre-wrap;white-space:-o-pre-wrap;word-wrap:break-word}pre.screen{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}pre.codeblock{margin-top:2px;margin-bottom:2px;padding:1.5px 1.5px 0 1.5px;border:0;white-space:pre}.dropdownAllButtonexpand{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4}.dropdownAllButtoncollapse{cursor:pointer;background-repeat:no-repeat;background-position:0 4px;padding-left:15px;background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;text-decoration:underline;color:#007af4}.dropdowntitle{background-repeat:no-repeat;background-position:0 4px;padding-left:15px;cursor:pointer;text-decoration:underline;color:#007af4}.dropdownexpand .dropdowntitle{background-image:url(icon-arrowdn.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapse .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.dropdowncollapsetable .dropdowntitle{background-image:url(icon-arrowrt.gif);text-decoration:underline;color:#007af4;margin:0 0 8px 0}.prefacesectiontitle1{margin-top:10.0pt;margin-right:0;margin-bottom:8.0pt;margin-left:-1cm;text-indent:0;font-size:18.0pt;font-family:"Book Antiqua";font-weight:bold;overflow:auto}.termcolor{color:blue;cursor:pointer}#dhtmlgoodies_tooltip{background-color:#f0f0d2;border:1px solid #000;position:absolute;display:none;z-index:20000;padding:2px;font-size:.9em;-moz-border-radius:6px;font-family:"Trebuchet MS","Lucida Sans Unicode",Arial,sans-serif}#dhtmlgoodies_tooltipShadow{position:absolute;background-color:#555;display:none;z-index:10000;opacity:.7;filter:alpha(opacity=70);-khtml-opacity:.7;-moz-opacity:.7;-moz-border-radius:6px}.freeze{position:fixed;_position:absolute;_top:expression(eval(document.documentElement.scrollTop));left:10;top:0}.hrcopyright{color:#3f4e5d;margin-top:18pt;margin-left:-1cm}.hwcopyright{text-align:center;font-family:Arial;margin-left:-1cm} \ No newline at end of file diff --git a/docs/lts/api-ref/public_sys-resources/commonrtl.css b/docs/lts/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..f261da75 --- /dev/null +++ b/docs/lts/api-ref/public_sys-resources/commonrtl.css @@ -0,0 +1,2 @@ +/*! Copyright (c) Huawei Technologies Co., Ltd. 2020-2022. All rights reserved. */.msgph{font-family:Courier New}.unresolved{background-color:#87ceeb}.noTemplate{background-color:#ff0}.base{background-color:#fff}/*! Add space for top level topics */.nested0,.p{margin-top:1em}/*! div with class=p is used for paragraphs that contain blocks, to keep the XHTML valid *//*! Default of italics to set apart figure captions */.figcap,.italic,.var{font-style:italic}.figdesc{font-style:normal}/*! Use @frame to create frames on figures */.figborder{padding-left:3px;padding-right:3px;margin-top:1em;border:2px solid Silver}.figsides{margin-top:1em;padding-left:3px;padding-right:3px;border-left:2px solid Silver;border-right:2px solid Silver}.figtop{border-top:2px solid Silver;margin-top:1em}.figbottom{border-bottom:2px solid Silver}.figtopbot{border-top:2px solid Silver;border-bottom:2px solid Silver;margin-top:1em}/*! Most link groups are created with
. Ensure they have space before and after. */.ullinks,ul.simple{list-style-type:none}.attention,.danger,.ddexpand,.dlexpand,.example,.fastpath,.important,.liexpand,.linklist,.note,.notice,.olchildlink,.relconcepts,.relinfo,.relref,.reltasks,.remember,.restriction,.section,.sliexpand,.stepexpand,.substepexpand,.tip,.ulchildlink,.warning{margin-top:1em;margin-bottom:1em}.linklistwithchild,.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em}.breadcrumb{font-size:smaller;margin-bottom:1em}.prereq{margin-right:20px}/*! Set heading sizes, getting smaller for deeper nesting */.topictitle1{font-size:1.34em;margin-top:0;margin-bottom:.1em}.topictitle2,.topictitle3,.topictitle4,.topictitle5,.topictitle6,.sectiontitle{font-size:1.17em}.topictitle2{margin-top:1pc;margin-bottom:.45em}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-weight:700}.topictitle4{margin-top:.83em;font-weight:700}.topictitle5{font-weight:700}.topictitle6{font-style:italic}.sectiontitle{margin-top:1em;margin-bottom:0;color:#000;font-weight:700}/*! All note formats have the same default presentation */.attentiontitle,.bold,.cautiontitle,.dangertitle,.dlterm,.fastpathtitle,.firstcol,.importanttitle,.notelisttitle,.notetitle,.noticetitle,.parmname,.remembertitle,.restrictiontitle,.tiptitle,.uicontrol,.warningtitle{font-weight:700}.caution{font-weight:700;margin-bottom:1em}/*! Simple lists do not get a bullet *//*! Used on the first column of a table, when rowheader="firstcol" is used *//*! Various basic phrase styles */.boldItalic{font-weight:700;font-style:italic}.shortcut,.underlined{text-decoration:underline}/*! 2008-10-27 keyword采用跟随上下文的样式 +*//*! Default of bold for definition list terms *//*! Use CSS to expand lists with @compact="no" */.dltermexpand{font-weight:700;margin-top:1em}[compact="yes"]>li{margin-top:0}[compact="no"]>li{margin-top:.53em}/*! Align images based on @align on topic/image */div.imageleft,.text-align-left{text-align:left}div.imagecenter,.text-align-center{text-align:center}div.imageright,.text-align-right{text-align:right}div.imagejustify,.text-align-justify{text-align:justify}.cellrowborder{border-right:0;border-top:0;border-left:1px solid;border-bottom:1px solid}.row-nocellborder{border-left:hidden;border-right:0;border-top:0;border-bottom:1px solid}.cell-norowborder{border-top:0;border-bottom:hidden;border-right:0;border-left:1px solid}.nocellnorowborder{border:0;border-left:hidden;border-bottom:hidden}pre.codeblock,pre.screen{padding:5px;border:outset;background-color:#ccc;margin-top:2px;margin-bottom:2px;white-space:pre} \ No newline at end of file diff --git a/docs/lts/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/lts/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/lts/api-ref/public_sys-resources/delta.gif b/docs/lts/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/deltaend.gif b/docs/lts/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/lts/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/lts/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-caution.gif b/docs/lts/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-danger.gif b/docs/lts/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-huawei.gif b/docs/lts/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-note.gif b/docs/lts/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-notice.gif b/docs/lts/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-tip.gif b/docs/lts/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/icon-warning.gif b/docs/lts/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/lts/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/lts/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/lts/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/lts/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/lts/api-ref/public_sys-resources/popup.js b/docs/lts/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..a550862e --- /dev/null +++ b/docs/lts/api-ref/public_sys-resources/popup.js @@ -0,0 +1 @@ +var i=0;var dhtmlgoodies_tooltipFlag=false;var dhtmlgoodies_tooltip="";var dhtmlgoodies_tooltipShadow="";var dhtmlgoodies_shadowSize=3;var dhtmlgoodies_tooltipMaxWidth=500;var dhtmlgoodies_tooltipMinWidth=100;var dhtmlgoodies_iframe=false;var timeId;var clickFlag=false;var tooltip_is_msie=(navigator.userAgent.indexOf("MSIE")>=0&&navigator.userAgent.indexOf("opera")==-1&&document.all)?true:false;var xPos;var yPos;window.document.onmousemove=function(a){a=a||window.event;if(a.pageX){xPos=a.pageX;yPos=a.pageY}else{if(document.body!==null&&typeof document.body!=="undefined"){xPos=a.clientX+document.body.scrollLeft-document.body.clientLeft;yPos=a.clientY+document.body.scrollTop-document.body.clientTop}}};function showTooltip(e){if(document.body===null||typeof document.body==="undefined"){return}if(i==0){return}clickFlag=true;var f=Json.parse("jsonData."+e);var a=Math.max(document.body.clientWidth,document.documentElement.clientWidth)-20;if(!dhtmlgoodies_tooltipFlag){dhtmlgoodies_tooltip=document.createElement("DIV");dhtmlgoodies_tooltip.id="dhtmlgoodies_tooltip";dhtmlgoodies_tooltipShadow=document.createElement("DIV");dhtmlgoodies_tooltipShadow.id="dhtmlgoodies_tooltipShadow";document.body.appendChild(dhtmlgoodies_tooltip);document.body.appendChild(dhtmlgoodies_tooltipShadow);if(tooltip_is_msie){dhtmlgoodies_iframe=document.createElement("IFRAME");dhtmlgoodies_iframe.frameborder="5";dhtmlgoodies_iframe.style.backgroundColor="#FFFFFF";dhtmlgoodies_iframe.src="#";dhtmlgoodies_iframe.style.zIndex=100;dhtmlgoodies_iframe.style.position="absolute";document.body.appendChild(dhtmlgoodies_iframe)}}dhtmlgoodies_tooltip.style.display="block";dhtmlgoodies_tooltipShadow.style.display="block";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="block"}var b=Math.max(document.body.scrollTop,document.documentElement.scrollTop);if(navigator.userAgent.toLowerCase().indexOf("safari")>=0){b=0}var c=xPos+10;dhtmlgoodies_tooltip.style.width=null;dhtmlgoodies_tooltip.innerHTML=f;dhtmlgoodies_tooltip.style.left=c+"px";if(tooltip_is_msie){dhtmlgoodies_tooltip.style.top=yPos+20+b+"px"}else{dhtmlgoodies_tooltip.style.top=yPos+20+"px"}dhtmlgoodies_tooltipShadow.style.left=c+dhtmlgoodies_shadowSize+"px";if(tooltip_is_msie){dhtmlgoodies_tooltipShadow.style.top=yPos+20+b+dhtmlgoodies_shadowSize+"px"}else{dhtmlgoodies_tooltipShadow.style.top=yPos+20+dhtmlgoodies_shadowSize+"px"}if(dhtmlgoodies_tooltip.offsetWidth>dhtmlgoodies_tooltipMaxWidth){dhtmlgoodies_tooltip.style.width=dhtmlgoodies_tooltipMaxWidth+"px"}var d=dhtmlgoodies_tooltip.offsetWidth;if(da){dhtmlgoodies_tooltip.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a))+"px";dhtmlgoodies_tooltipShadow.style.left=(dhtmlgoodies_tooltipShadow.style.left.replace("px","")-((c+d)-a)+dhtmlgoodies_shadowSize)+"px"}if(tooltip_is_msie){dhtmlgoodies_iframe.style.left=dhtmlgoodies_tooltip.style.left;dhtmlgoodies_iframe.style.top=dhtmlgoodies_tooltip.style.top;dhtmlgoodies_iframe.style.width=dhtmlgoodies_tooltip.offsetWidth+"px";dhtmlgoodies_iframe.style.height=dhtmlgoodies_tooltip.offsetHeight+"px"}}function hideTooltip(){i=0;clickFlag=false;if((dhtmlgoodies_tooltip!==null&&typeof dhtmlgoodies_tooltip!=="undefined")&&+(dhtmlgoodies_tooltip.style!==null&&typeof dhtmlgoodies_tooltip.style!=="undefined")){dhtmlgoodies_tooltip.style.display="none";dhtmlgoodies_tooltipShadow.style.display="none";if(tooltip_is_msie){dhtmlgoodies_iframe.style.display="none"}}if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}function showText(a){i=1;timeId=setTimeout(function(){showTooltip(a)},500)}function showText2(a){if(!clickFlag){i=1;showTooltip(a);i=0;if(timeId!==null&&typeof timeId!=="undefined"&&timeId!=""){clearTimeout(timeId)}}}function anchorScroll(b){var d=document.getElementsByName(b);if(d!=null&&d.length>0){var c=d[0];var a=c.getBoundingClientRect().left+(document.body.scrollLeft||(document.documentElement&&document.documentElement.scrollLeft));var e=c.getBoundingClientRect().top+(document.body.scrollTop||(document.documentElement&&document.documentElement.scrollTop));window.scrollTo(a,e-30)}}; \ No newline at end of file diff --git a/docs/lts/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/lts/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/warning_3.0-en-us.png differ