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.
+
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
+
- Parameter description
+
Table 1 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID
+ |
+
+
+
+
+
+
Request
- Request parameters
+
Table 2 Parameter descriptionParameter
+ |
+Sub-Parameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+log_group_name
+ |
+N/A
+ |
+Yes
+ |
+String
+ |
+Log group name.
+The configuration rules are as follows:
+- Must be a string of 1 to 64 characters.
- Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. The name cannot start or end with a period.
+ |
+
+ttl_in_days
+ |
+N/A
+ |
+Yes
+ |
+Int
+ |
+Log expiration time. The value is fixed to 7 days.
+ |
+
+
+
+
+
+
+
Response
- Response parameters
+
Table 3 Parameter descriptionParameter
+ |
+Sub-Parameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+log_group_id
+ |
+N/A
+ |
+String
+ |
+Log group ID
+ |
+
+
+
+
+
+
+
+
Function
This function describes how to query a log group you have created to obtain its name, ID, expiration time, and creation time.
+
+
URI
+
- Parameter description
+
Table 1 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID
+ |
+
+group_id
+ |
+Yes
+ |
+String
+ |
+Log group ID
+ |
+
+
+
+
+
+
+
Response
- Response parameters
+
Table 2 Parameter descriptionParameter
+ |
+Sub-Parameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+log_group_id
+ |
+-
+ |
+String
+ |
+Log group ID
+ |
+
+log_group_name
+ |
+-
+ |
+String
+ |
+Log group name
+ |
+
+creation_time
+ |
+-
+ |
+Int64
+ |
+Log group creation time
+ |
+
+ttl_in_days
+ |
+-
+ |
+Int
+ |
+Log expiration time
+ |
+
+
+
+
- Example response
{
+ "log_group_id": "8ac95c07-357b-11e9-bc2a-286ed488ce71",
+ "log_group_name": "lts-group-3h0y",
+ "creation_time": 1550714033721,
+ "ttl_in_days": 7
+}
+
+
+
+
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
+
- Parameter description
+
Table 1 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID
+ |
+
+group_id
+ |
+Yes
+ |
+String
+ |
+ID of a created log group
+ |
+
+
+
+
+
+
+
Response
- Response parameters
None
+ - Example response
None
+
+
+
+
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
+
- Parameter description
+
Table 1 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID
+ |
+
+group_id
+ |
+Yes
+ |
+String
+ |
+ID of a created log group
+ |
+
+
+
+
+
+
Request
- Request parameters
+
Table 2 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+log_topic_name
+ |
+Yes
+ |
+String
+ |
+Log stream name.
+The configuration rules are as follows:
+- Must be a string of 1 to 64 characters.
- Only letters, digits, underscores (_), hyphens (-), and periods (.) are allowed. The name cannot start or end with a period.
+ |
+
+
+
+
+
+
+
Response
- Response parameters
+
Table 3 Parameter descriptionParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+log_topic_id
+ |
+String
+ |
+ID of 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
+
- Parameter description
+
Table 1 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID
+ |
+
+group_id
+ |
+Yes
+ |
+String
+ |
+Log group ID
+ |
+
+topic_id
+ |
+Yes
+ |
+String
+ |
+ID of 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
+
- Parameter description
+
Table 1 Parameter descriptionParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID
+ |
+
+group_id
+ |
+Yes
+ |
+String
+ |
+ID of a created log group
+ |
+
+topic_id
+ |
+Yes
+ |
+String
+ |
+ID of a created log stream
+ |
+
+
+
+
+
+
+
Response
- Parameter description
None
+ - Example response
None
+
+
+
+
Table 1 lists the status code.
+
+
Table 1 Status code descriptionStatus 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.
+ |
+
+
+
+
+
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 descriptionResponse 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.
+ |
+
+
+
+
+
+
. 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 000000000..47a9c7235
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 000000000..0d1b1f674
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 000000000..cc7da0fc8
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 000000000..84eec9be2
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 000000000..39583d168
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 000000000..079c79b26
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 000000000..079c79b26
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 000000000..a31d60f89
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 000000000..31be2b039
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 000000000..409070650
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 000000000..c47bae05c
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 000000000..079c79b26
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 000000000..57a0e1f53
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 000000000..fa4b64990
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 000000000..a550862ed
--- /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 000000000..def5c3565
Binary files /dev/null and b/docs/lts/api-ref/public_sys-resources/warning_3.0-en-us.png differ