diff --git a/docs/cts/api-ref/ALL_META.TXT.json b/docs/cts/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..669ccc5f --- /dev/null +++ b/docs/cts/api-ref/ALL_META.TXT.json @@ -0,0 +1,212 @@ +[ + { + "uri":"en-us_topic_0168602179.html", + "product_code":"cts", + "code":"1", + "des":"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 Resourc", + "doc_type":"api", + "kw":"API Usage Guidelines,API Reference", + "title":"API Usage Guidelines", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602260.html", + "product_code":"cts", + "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":"API Description", + "title":"API Description", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602231.html", + "product_code":"cts", + "code":"3", + "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":"API Version Management", + "title":"API Version Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602247.html", + "product_code":"cts", + "code":"4", + "des":"This API is used to query all API versions supported by Cloud Trace Service (CTS).GET /NoneParameter descriptionParameters in the responseParameterMandatoryTypeDescriptio", + "doc_type":"api", + "kw":"Querying All API Versions,API Version Management,API Reference", + "title":"Querying All API Versions", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602243.html", + "product_code":"cts", + "code":"5", + "des":"This API is used to query a specified API version of CTS.GET/{api_version}The URI parameters are described in Table 1.Parameters in the URIParameterMandatoryDescriptionap", + "doc_type":"api", + "kw":"Querying a Specified API Version,API Version Management,API Reference", + "title":"Querying a Specified API Version", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602232.html", + "product_code":"cts", + "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":"Tracker Management", + "title":"Tracker Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602251.html", + "product_code":"cts", + "code":"7", + "des":"All API URLs described in this section are case-sensitive.This API is used to create a tracker.A tracker will be automatically created when CTS is enabled. All traces rec", + "doc_type":"api", + "kw":"Creating a Tracker,Tracker Management,API Reference", + "title":"Creating a Tracker", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602227.html", + "product_code":"cts", + "code":"8", + "des":"CTS allows you to modify configuration parameters of a created tracker, including parameters related to Transfer to OBS and Trace Analysis. You can also change tracker st", + "doc_type":"api", + "kw":"Modifying a Tracker,Tracker Management,API Reference", + "title":"Modifying a Tracker", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602253.html", + "product_code":"cts", + "code":"9", + "des":"This API is used to query the details of a tracker. The details include the name of the tracker, name of the OBS bucket for storing traces, and prefix of the trace files ", + "doc_type":"api", + "kw":"Querying a Tracker,Tracker Management,API Reference", + "title":"Querying a Tracker", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602223.html", + "product_code":"cts", + "code":"10", + "des":"This API is used to delete a tracker. Deleting a tracker has no impact on the operation records that have been generated. When you enable CTS again, you can still view th", + "doc_type":"api", + "kw":"Deleting a Tracker,Tracker Management,API Reference", + "title":"Deleting a Tracker", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602178.html", + "product_code":"cts", + "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":"Trace Management", + "title":"Trace Management", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602225.html", + "product_code":"cts", + "code":"12", + "des":"This API is used to query records of operations on resources in the last seven days.GET /v1.0/{project_id}/{tracker_name}/trace{?trace_id,service_type,resource_type,resou", + "doc_type":"api", + "kw":"Querying Traces (v1.0),Trace Management,API Reference", + "title":"Querying Traces (v1.0)", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602252.html", + "product_code":"cts", + "code":"13", + "des":"This API is used to query records of operations on resources in the last seven days. In v2.0, the request parameter trace_rating is changed to trace_status, and the type ", + "doc_type":"api", + "kw":"Querying Traces (v2.0),Trace Management,API Reference", + "title":"Querying Traces (v2.0)", + "githuburl":"" + }, + { + "uri":"topic_300000003.html", + "product_code":"", + "code":"14", + "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":"Key Event Notification Management", + "title":"Key Event Notification Management", + "githuburl":"" + }, + { + "uri":"cts_api_0312.html", + "product_code":"", + "code":"15", + "des":"SMS, email, or HTTP/HTTPS notifications can be sent through pre-configured SMN topics to subscribers when key operations occur. This helps you detect high-risk operations", + "doc_type":"api", + "kw":"Creating a Key Event Notification,Key Event Notification Management,API Reference", + "title":"Creating a Key Event Notification", + "githuburl":"" + }, + { + "uri":"cts_api_0313.html", + "product_code":"", + "code":"16", + "des":"This API is used to modify a key event notification. The notification ID carried in the request must be valid.PUT /v3/{project_id}/notificationsStatus code: 200Status cod", + "doc_type":"api", + "kw":"Modifying a Key Event Notification,Key Event Notification Management,API Reference", + "title":"Modifying a Key Event Notification", + "githuburl":"" + }, + { + "uri":"cts_api_0314.html", + "product_code":"", + "code":"17", + "des":"This API is used to delete a key event notification.DELETE /v3/{project_id}/notificationsNoneStatus code: 400NoneNoneSee Error Codes.", + "doc_type":"api", + "kw":"Deleting a Key Event Notification,Key Event Notification Management,API Reference", + "title":"Deleting a Key Event Notification", + "githuburl":"" + }, + { + "uri":"cts_api_0315.html", + "product_code":"", + "code":"18", + "des":"This API is used to query a key event notification.GET /v3/{project_id}/notifications/{notification_type}NoneStatus code: 200Status code: 400NoneStatus code: 200The query", + "doc_type":"api", + "kw":"Querying a Key Event Notification,Key Event Notification Management,API Reference", + "title":"Querying a Key Event Notification", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602233.html", + "product_code":"cts", + "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":"Public Parameters", + "title":"Public Parameters", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602259.html", + "product_code":"cts", + "code":"20", + "des":"This section explains the meanings of error codes returned by CTS APIs.{\"error_code\": \"CTS.0003\",\"error_msg\": \"Invalid message body. The message body is empty or invalid.", + "doc_type":"api", + "kw":"Error Codes,Public Parameters,API Reference", + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"en-us_topic_0168602228.html", + "product_code":"cts", + "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":"Change History,API Reference", + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/cts/api-ref/CLASS.TXT.json b/docs/cts/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..38cb0350 --- /dev/null +++ b/docs/cts/api-ref/CLASS.TXT.json @@ -0,0 +1,191 @@ +[ + { + "desc":"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 Resourc", + "product_code":"cts", + "title":"API Usage Guidelines", + "uri":"en-us_topic_0168602179.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":"cts", + "title":"API Description", + "uri":"en-us_topic_0168602260.html", + "doc_type":"api", + "p_code":"", + "code":"2" + }, + { + "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":"cts", + "title":"API Version Management", + "uri":"en-us_topic_0168602231.html", + "doc_type":"api", + "p_code":"2", + "code":"3" + }, + { + "desc":"This API is used to query all API versions supported by Cloud Trace Service (CTS).GET /NoneParameter descriptionParameters in the responseParameterMandatoryTypeDescriptio", + "product_code":"cts", + "title":"Querying All API Versions", + "uri":"en-us_topic_0168602247.html", + "doc_type":"api", + "p_code":"3", + "code":"4" + }, + { + "desc":"This API is used to query a specified API version of CTS.GET/{api_version}The URI parameters are described in Table 1.Parameters in the URIParameterMandatoryDescriptionap", + "product_code":"cts", + "title":"Querying a Specified API Version", + "uri":"en-us_topic_0168602243.html", + "doc_type":"api", + "p_code":"3", + "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":"cts", + "title":"Tracker Management", + "uri":"en-us_topic_0168602232.html", + "doc_type":"api", + "p_code":"2", + "code":"6" + }, + { + "desc":"All API URLs described in this section are case-sensitive.This API is used to create a tracker.A tracker will be automatically created when CTS is enabled. All traces rec", + "product_code":"cts", + "title":"Creating a Tracker", + "uri":"en-us_topic_0168602251.html", + "doc_type":"api", + "p_code":"6", + "code":"7" + }, + { + "desc":"CTS allows you to modify configuration parameters of a created tracker, including parameters related to Transfer to OBS and Trace Analysis. You can also change tracker st", + "product_code":"cts", + "title":"Modifying a Tracker", + "uri":"en-us_topic_0168602227.html", + "doc_type":"api", + "p_code":"6", + "code":"8" + }, + { + "desc":"This API is used to query the details of a tracker. The details include the name of the tracker, name of the OBS bucket for storing traces, and prefix of the trace files ", + "product_code":"cts", + "title":"Querying a Tracker", + "uri":"en-us_topic_0168602253.html", + "doc_type":"api", + "p_code":"6", + "code":"9" + }, + { + "desc":"This API is used to delete a tracker. Deleting a tracker has no impact on the operation records that have been generated. When you enable CTS again, you can still view th", + "product_code":"cts", + "title":"Deleting a Tracker", + "uri":"en-us_topic_0168602223.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":"cts", + "title":"Trace Management", + "uri":"en-us_topic_0168602178.html", + "doc_type":"api", + "p_code":"2", + "code":"11" + }, + { + "desc":"This API is used to query records of operations on resources in the last seven days.GET /v1.0/{project_id}/{tracker_name}/trace{?trace_id,service_type,resource_type,resou", + "product_code":"cts", + "title":"Querying Traces (v1.0)", + "uri":"en-us_topic_0168602225.html", + "doc_type":"api", + "p_code":"11", + "code":"12" + }, + { + "desc":"This API is used to query records of operations on resources in the last seven days. In v2.0, the request parameter trace_rating is changed to trace_status, and the type ", + "product_code":"cts", + "title":"Querying Traces (v2.0)", + "uri":"en-us_topic_0168602252.html", + "doc_type":"api", + "p_code":"11", + "code":"13" + }, + { + "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":"cts", + "title":"Key Event Notification Management", + "uri":"topic_300000003.html", + "doc_type":"api", + "p_code":"2", + "code":"14" + }, + { + "desc":"SMS, email, or HTTP/HTTPS notifications can be sent through pre-configured SMN topics to subscribers when key operations occur. This helps you detect high-risk operations", + "product_code":"cts", + "title":"Creating a Key Event Notification", + "uri":"cts_api_0312.html", + "doc_type":"api", + "p_code":"14", + "code":"15" + }, + { + "desc":"This API is used to modify a key event notification. The notification ID carried in the request must be valid.PUT /v3/{project_id}/notificationsStatus code: 200Status cod", + "product_code":"cts", + "title":"Modifying a Key Event Notification", + "uri":"cts_api_0313.html", + "doc_type":"api", + "p_code":"14", + "code":"16" + }, + { + "desc":"This API is used to delete a key event notification.DELETE /v3/{project_id}/notificationsNoneStatus code: 400NoneNoneSee Error Codes.", + "product_code":"cts", + "title":"Deleting a Key Event Notification", + "uri":"cts_api_0314.html", + "doc_type":"api", + "p_code":"14", + "code":"17" + }, + { + "desc":"This API is used to query a key event notification.GET /v3/{project_id}/notifications/{notification_type}NoneStatus code: 200Status code: 400NoneStatus code: 200The query", + "product_code":"cts", + "title":"Querying a Key Event Notification", + "uri":"cts_api_0315.html", + "doc_type":"api", + "p_code":"14", + "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":"cts", + "title":"Public Parameters", + "uri":"en-us_topic_0168602233.html", + "doc_type":"api", + "p_code":"", + "code":"19" + }, + { + "desc":"This section explains the meanings of error codes returned by CTS APIs.{\"error_code\": \"CTS.0003\",\"error_msg\": \"Invalid message body. The message body is empty or invalid.", + "product_code":"cts", + "title":"Error Codes", + "uri":"en-us_topic_0168602259.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":"cts", + "title":"Change History", + "uri":"en-us_topic_0168602228.html", + "doc_type":"api", + "p_code":"", + "code":"21" + } +] \ No newline at end of file diff --git a/docs/cts/api-ref/PARAMETERS.txt b/docs/cts/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/cts/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/cts/api-ref/cts_api_0312.html b/docs/cts/api-ref/cts_api_0312.html new file mode 100644 index 00000000..6c1d675b --- /dev/null +++ b/docs/cts/api-ref/cts_api_0312.html @@ -0,0 +1,484 @@ + + +

Creating a Key Event Notification

+

Function

SMS, email, or HTTP/HTTPS notifications can be sent through pre-configured SMN topics to subscribers when key operations occur. This helps you detect high-risk operations promptly. Notifications can also be used as triggers for specific operations or to connect to your own audit system.

+
+

URI

POST /v3/{project_id}/notifications

+ +
+ + + + + + + + + + + +
Table 1 URI parameter

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

notification_name

+

Yes

+

String

+

Notification name.

+

operation_type

+

Yes

+

String

+

Operation type. Possible options include complete and customized. If you choose complete, you do not need to specify operations and notify_user_list, and notifications will be sent when any supported operations occur on any of the connected cloud services. If you choose customized, notifications will be sent when operations defined in operations occur.

+

Enumerated values:

+
  • complete
  • customized
+

operations

+

No

+

Array of Operations objects

+

Operation list.

+

notify_user_list

+

No

+

Array of NotificationUsers objects

+

List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.

+

topic_id

+

No

+

String

+

Topic URN.

+
  • To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Operations

Parameter

+

Mandatory

+

Type

+

Description

+

service_type

+

Yes

+

String

+

Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.

+

resource_type

+

Yes

+

String

+

Resource type.

+

trace_names

+

Yes

+

Array of strings

+

Trace name.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 NotificationUsers

Parameter

+

Mandatory

+

Type

+

Description

+

user_group

+

Yes

+

String

+

IAM user group.

+

user_list

+

Yes

+

Array of strings

+

IAM user.

+
+
+
+

Response Parameters

Status code: 201

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

notification_name

+

String

+

Notification name.

+

operation_type

+

String

+

Operation type. Possible options include complete and customized.

+

Enumerated values:

+
  • customized
  • complete
+

operations

+

Array of Operations objects

+

Operation list.

+

notify_user_list

+

Array of NotificationUsers objects

+

List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.

+

status

+

String

+

Notification status. Possible options include enabled and disabled.

+

Enumerated values:

+
  • enabled
  • disabled
+

topic_id

+

String

+

Unique resource ID of an SMN topic. You can obtain the ID by querying the topic list.

+

notification_id

+

String

+

Unique notification ID.

+

notification_type

+

String

+

Notification type.

+

Enumerated value:

+
  • smn
+

project_id

+

String

+

Project ID.

+

create_time

+

Long

+

Time when a notification rule was created.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Operations

Parameter

+

Type

+

Description

+

service_type

+

String

+

Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.

+

resource_type

+

String

+

Resource type.

+

trace_names

+

Array of strings

+

Trace name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 NotificationUsers

Parameter

+

Type

+

Description

+

user_group

+

String

+

IAM user group.

+

user_list

+

Array of strings

+

IAM user.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code. Format: CTS.XXX.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Request

+
+

Example Response

Status code: 201

+

The creation is successful.

+
{
+  "create_time" : 1634001495876,
+  "notification_id" : "cda8fd83-d08c-46f0-b914-1453a6a85c00",
+  "notification_name" : "keyOperate_info_cfwy",
+  "notification_type" : "smn",
+  "notify_user_list" : [ {
+    "user_group" : "admin",
+    "user_list" : [ "test1", "test2" ]
+  }, {
+    "user_group" : "CTS view",
+    "user_list" : [ "test3", "test4" ]
+  } ],
+  "operation_type" : "customized",
+  "operations" : [ {
+    "resource_type" : "tracker",
+    "service_type" : "CTS",
+    "trace_names" : [ "createTracker", "deleteTraceker" ]
+  }, {
+    "resource_type" : "notification",
+    "service_type" : "CTS",
+    "trace_names" : [ "deleteNotification", "updateNotification" ]
+  }, {
+    "resource_type" : "pe",
+    "service_type" : "AOM",
+    "trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ]
+  } ],
+  "project_id" : "24edf66e79d04187acb99a463e610764",
+  "status" : "enabled",
+  "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
+}
+
+

Status Codes

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

Status Code

+

Description

+

201

+

The creation is successful.

+

400

+

The server failed to process the request.

+

401

+

The request is rejected due to authentication failure.

+

403

+

The server understood the request but refused to authorize it.

+

404

+

The server failed to find the requested resource or some key event notifications failed to be deleted.

+

500

+

The request failed to be executed or some trackers failed to be deleted.

+

503

+

The requested service is unavailable. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Key Event Notification Management
+
+
+ diff --git a/docs/cts/api-ref/cts_api_0313.html b/docs/cts/api-ref/cts_api_0313.html new file mode 100644 index 00000000..1c99fc83 --- /dev/null +++ b/docs/cts/api-ref/cts_api_0313.html @@ -0,0 +1,482 @@ + + +

Modifying a Key Event Notification

+

Function

This API is used to modify a key event notification. The notification ID carried in the request must be valid.

+
+

URI

PUT /v3/{project_id}/notifications

+ +
+ + + + + + + + + + + +
Table 1 URI parameter

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

notification_name

+

Yes

+

String

+

Notification name.

+

operation_type

+

Yes

+

String

+

Operation type. Possible options include complete and customized. If you choose complete, notifications will be sent when any supported operation occurs on any of the connected cloud services. If you choose customized, notifications will be sent when operations defined in operations occur.

+

Enumerated values:

+
  • customized
  • complete
+

operations

+

No

+

Array of Operations objects

+

Operation list.

+

notify_user_list

+

No

+

Array of NotificationUsers objects

+

List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.

+

status

+

Yes

+

String

+

Notification status. Possible options include enabled and disabled.

+

Enumerated values:

+
  • enabled
  • disabled
+

topic_id

+

No

+

String

+

Topic URN. This parameter is mandatory when status is set to enabled.

+
  • To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
+

notification_id

+

Yes

+

String

+

Notification ID.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Operations

Parameter

+

Mandatory

+

Type

+

Description

+

service_type

+

Yes

+

String

+

Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.

+

resource_type

+

Yes

+

String

+

Resource type.

+

trace_names

+

Yes

+

Array of strings

+

Trace name.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 NotificationUsers

Parameter

+

Mandatory

+

Type

+

Description

+

user_group

+

Yes

+

String

+

IAM user group.

+

user_list

+

Yes

+

Array of strings

+

IAM user.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

notification_name

+

String

+

Notification name.

+

operation_type

+

String

+

Operation type. Possible options include complete and customized. If you choose complete, notifications will be sent when any supported operation occurs on any of the connected cloud services. If you choose customized, notifications will be sent when operations defined in operations occur.

+

Enumerated values:

+
  • customized
  • complete
+

operations

+

Array of Operations objects

+

Operation list.

+

notify_user_list

+

Array of NotificationUsers objects

+

List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.

+

status

+

String

+

Notification status. Possible options include enabled and disabled.

+

Enumerated values:

+
  • enabled
  • disabled
+

topic_id

+

String

+

Topic URN.

+
  • To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
+

notification_id

+

String

+

Unique notification ID.

+

notification_type

+

String

+

Notification type.

+

Enumerated value:

+
  • smn
+

project_id

+

String

+

Project ID.

+

create_time

+

Long

+

Timestamp when a notification was created.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 Operations

Parameter

+

Type

+

Description

+

service_type

+

String

+

Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.

+

resource_type

+

String

+

Resource type.

+

trace_names

+

Array of strings

+

Trace name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 NotificationUsers

Parameter

+

Type

+

Description

+

user_group

+

String

+

IAM user group.

+

user_list

+

Array of strings

+

IAM user.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code. Format: CTS.XXX.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Request

Modifying a key event notification

+
PUT https://{endpoint}/v3/{project_id}/notifications
+
+{
+  "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
+  "notification_name" : "keyOperate_info_cfwy",
+  "operation_type" : "customized",
+  "operations" : [ {
+    "service_type" : "CTS",
+    "resource_type" : "tracker",
+    "trace_names" : [ "createTracker", "deleteTraceker" ]
+  }, {
+    "service_type" : "CTS",
+    "resource_type" : "notification",
+    "trace_names" : [ "deleteNotification", "updateNotification" ]
+  }, {
+    "service_type" : "AOM",
+    "resource_type" : "pe",
+    "trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ]
+  } ],
+  "notify_user_list" : [ {
+    "user_group" : "admin",
+    "user_list" : [ "test", "test1" ]
+  }, {
+    "user_group" : "CTS view",
+    "user_list" : [ "test2", "test3" ]
+  } ],
+  "status" : "enabled",
+  "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:foo"
+}
+
+

Example Response

Status code: 200

+

The notification is modified.

+
{
+  "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
+  "notification_name" : "keyOperate_info_cfwy",
+  "operation_type" : "customized",
+  "operations" : [ {
+    "service_type" : "CTS",
+    "resource_type" : "tracker",
+    "trace_names" : [ "createTracker", "deleteTraceker" ]
+  }, {
+    "service_type" : "CTS",
+    "resource_type" : "notification",
+    "trace_names" : [ "deleteNotification", "updateNotification" ]
+  }, {
+    "service_type" : "AOM",
+    "resource_type" : "pe",
+    "trace_names" : [ "deletePolicyGroup", "updatePolicyGroup", "createPolicyGroup" ]
+  } ],
+  "notify_user_list" : [ {
+    "user_group" : "admin",
+    "user_list" : [ "test", "test1" ]
+  }, {
+    "user_group" : "CTS view",
+    "user_list" : [ "test2", "test3" ]
+  } ],
+  "status" : "enabled",
+  "project_id" : "24edf66e79d04187acb99a463e610764",
+  "notification_type" : "smn",
+  "create_time" : 1634001495876,
+  "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:foo"
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The notification is modified.

+

400

+

The server failed to process the request.

+

401

+

The request is rejected due to authentication failure.

+

403

+

The server understood the request but refused to authorize it.

+

404

+

The server failed to find the requested resource or some key event notifications failed to be deleted.

+

500

+

The request failed to be executed or some trackers failed to be deleted.

+

503

+

The requested service is unavailable. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Key Event Notification Management
+
+
+ diff --git a/docs/cts/api-ref/cts_api_0314.html b/docs/cts/api-ref/cts_api_0314.html new file mode 100644 index 00000000..e9713e6c --- /dev/null +++ b/docs/cts/api-ref/cts_api_0314.html @@ -0,0 +1,142 @@ + + +

Deleting a Key Event Notification

+

Function

This API is used to delete a key event notification.

+
+

URI

DELETE /v3/{project_id}/notifications

+ +
+ + + + + + + + + + + +
Table 1 URI parameter

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

+
+
+ +
+ + + + + + + + + + + +
Table 2 Query parameter

Parameter

+

Mandatory

+

Type

+

Description

+

notification_id

+

Yes

+

String

+

Notification ID. To batch delete notifications, enter multiple notification IDs separated by commas (,), for example, notification_id="xxx1,ccc2".

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code. Format: CTS.XXX.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Request

None

+
+

Example Response

None

+
+

Status Codes

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

Status Code

+

Description

+

204

+

The deletion is successful.

+

400

+

The server failed to process the request.

+

401

+

The request is rejected due to authentication failure.

+

403

+

The server understood the request but refused to authorize it.

+

404

+

The server failed to find the requested resource or some key event notifications failed to be deleted.

+

500

+

The request failed to be executed or some trackers failed to be deleted.

+

503

+

The requested service is unavailable. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Key Event Notification Management
+
+
+ diff --git a/docs/cts/api-ref/cts_api_0315.html b/docs/cts/api-ref/cts_api_0315.html new file mode 100644 index 00000000..3404598e --- /dev/null +++ b/docs/cts/api-ref/cts_api_0315.html @@ -0,0 +1,370 @@ + + +

Querying a Key Event Notification

+

Function

This API is used to query a key event notification.

+
+

URI

GET /v3/{project_id}/notifications/{notification_type}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 URI parameters

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.

+

notification_type

+

Yes

+

String

+

Notification type.

+

Enumerated value:

+
  • smn
+
+
+ +
+ + + + + + + + + + + +
Table 2 Query parameter

Parameter

+

Mandatory

+

Type

+

Description

+

notification_name

+

No

+

String

+

Notification name. If this parameter is not specified, all key event notifications configured in the current tenant account are returned.

+
+
+
+

Request Parameters

None

+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameter

Parameter

+

Type

+

Description

+

notifications

+

Array of NotificationsResponseBody objects

+

Notification list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 NotificationsResponseBody

Parameter

+

Type

+

Description

+

notification_name

+

String

+

Notification name.

+

operation_type

+

String

+

Operation type. Possible options include complete and customized. If you choose complete, notifications will be sent when any supported operation occurs on any of the connected cloud services. If you choose customized, notifications will be sent when operations defined in operations occur.

+

Enumerated values:

+
  • customized
  • complete
+

operations

+

Array of Operations objects

+

Operation list.

+

notify_user_list

+

Array of NotificationUsers objects

+

List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.

+

status

+

String

+

Notification status. Possible options include enabled and disabled.

+

Enumerated values:

+
  • enabled
  • disabled
+

topic_id

+

String

+

Topic URN.

+
  • To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
+

notification_id

+

String

+

Unique notification ID.

+

notification_type

+

String

+

Notification type.

+

Enumerated value:

+
  • smn
+

project_id

+

String

+

Project ID.

+

create_time

+

Long

+

Timestamp when a notification was created.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 Operations

Parameter

+

Type

+

Description

+

service_type

+

String

+

Cloud service. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.

+

resource_type

+

String

+

Resource type.

+

trace_names

+

Array of strings

+

Trace name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 NotificationUsers

Parameter

+

Type

+

Description

+

user_group

+

String

+

IAM user group.

+

user_list

+

Array of strings

+

IAM user.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Error code. Format: CTS.XXX.

+

error_msg

+

String

+

Error description.

+
+
+
+

Example Request

None

+
+

Example Response

Status code: 200

+

The query is successful.

+
{
+  "notifications" : [ {
+    "create_time" : 1633933167385,
+    "notify_user_list" : [ {
+      "user_group" : "admin",
+      "user_list" : [ "test1", "test2" ]
+    }, {
+      "user_group" : "CTS view",
+      "user_list" : [ "test3", "test4" ]
+    } ],
+    "notification_id" : "0b98e1c2-2fd6-4e33-a355-f9e12eaab88a",
+    "notification_name" : "test2",
+    "notification_type" : "smn",
+    "operation_type" : "customized",
+    "operations" : [ {
+      "resource_type" : "tracker",
+      "service_type" : "CTS",
+      "trace_names" : [ "createTracker" ]
+    }, {
+      "resource_type" : "notification",
+      "service_type" : "CTS",
+      "trace_names" : [ "deleteNotification", "updateNotification" ]
+    }, {
+      "resource_type" : "pe",
+      "service_type" : "AOM",
+      "trace_names" : [ "createPolicyGroup", "updatePolicyGroup", "deletePolicyGroup" ]
+    } ],
+    "project_id" : "24edf66e79d04187acb99a463e610764",
+    "status" : "enabled",
+    "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
+  }, {
+    "create_time" : 1633924057706,
+    "notify_user_list" : [ {
+      "user_group" : "admin",
+      "user_list" : [ "test1", "test2" ]
+    }, {
+      "user_group" : "CTS view",
+      "user_list" : [ "test3", "test4" ]
+    } ],
+    "notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
+    "notification_name" : "test1",
+    "notification_type" : "smn",
+    "operation_type" : "complete",
+    "operations" : [ ],
+    "project_id" : "24edf66e79d04187acb99a463e610764",
+    "status" : "disabled"
+  } ]
+}
+
+

Status Codes

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

Status Code

+

Description

+

200

+

The query is successful.

+

400

+

The server failed to process the request.

+

401

+

The request is rejected due to authentication failure.

+

403

+

The server understood the request but refused to authorize it.

+

404

+

The server failed to find the requested resource or some key event notifications failed to be deleted.

+

500

+

The request failed to be executed or some trackers failed to be deleted.

+

503

+

The requested service is unavailable. The client should not repeat the request without modifications.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Key Event Notification Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602178.html b/docs/cts/api-ref/en-us_topic_0168602178.html new file mode 100644 index 00000000..d6dad6e4 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602178.html @@ -0,0 +1,17 @@ + + +

Trace Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602179.html b/docs/cts/api-ref/en-us_topic_0168602179.html new file mode 100644 index 00000000..f1f45766 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602179.html @@ -0,0 +1,8 @@ + + +

API Usage Guidelines

+

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://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602223.html b/docs/cts/api-ref/en-us_topic_0168602223.html new file mode 100644 index 00000000..ef722de4 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602223.html @@ -0,0 +1,110 @@ + + +

Deleting a Tracker

+

Function

This API is used to delete a tracker. Deleting a tracker has no impact on the operation records that have been generated. When you enable CTS again, you can still view those records.

+
+

URI

DELETE /v1.0/{project_id}/tracker?tracker_name={tracker_name}

+
The URI parameters are described in Table1 Parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

tracker_name

+

No

+

String

+

Tracker name.

+

If this parameter is not specified, all trackers will be deleted.

+
+
+
+
+

Request

+ +
+

Response

+ +
+

Returned Value

+
+
+
+
+
Parent topic: Tracker Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602225.html b/docs/cts/api-ref/en-us_topic_0168602225.html new file mode 100644 index 00000000..c78e6acb --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602225.html @@ -0,0 +1,491 @@ + + +

Querying Traces (v1.0)

+

Function

This API is used to query records of operations on resources in the last seven days.

+
+

URI

GET /v1.0/{project_id}/{tracker_name}/trace{?trace_id,service_type,resource_type,resource_id,resource_name,trace_name,trace_rating,user,limit,from,to,next}

+
The URI parameters are described in Table1 Parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

tracker_name

+

Yes

+

String

+

Tracker name. Currently, only one tracker is allowed for each tenant. The tracker name is system.

+
+
+
+
+

Request

+ +
+

Response

+ +
+

Returned Value

+
+
+
+
+
Parent topic: Trace Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602227.html b/docs/cts/api-ref/en-us_topic_0168602227.html new file mode 100644 index 00000000..3e470902 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602227.html @@ -0,0 +1,262 @@ + + +

Modifying a Tracker

+

Function

CTS allows you to modify configuration parameters of a created tracker, including parameters related to Transfer to OBS and Trace Analysis. You can also change tracker status by clicking Enable or Disable in the Operation column. Modifying tracker parameters does not affect the existing operation records. After the modification is complete, the system will immediately start recording operations based on the new rule.

+
+

URI

PUT /v1.0/{project_id}/tracker/{tracker_name}

+
The URI parameters are described in Table1 Parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

tracker_name

+

Yes

+

String

+

Tracker name. Currently, only one tracker is allowed for each tenant. The tracker name is system.

+
+
+
+
+

Request

+ +
+

Response

+ +
+
{
+	"bucket_name" : "my_created_bucket",
+	"tracker_name" : "system",
+	"file_prefix_name" : "some_folder",
+	"lts" : {
+		"is_lts_enabled" : true,
+		"log_group_name" : "CTS",
+		"log_topic_name" : "system-trace"
+	},
+	"status" : "disabled"    
+        "bucket_name" : "1214",    
+        "tracker_name" : "system",    
+}
+

Returned Value

+
+
+
+
+
Parent topic: Tracker Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602228.html b/docs/cts/api-ref/en-us_topic_0168602228.html new file mode 100644 index 00000000..1d0e1dac --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602228.html @@ -0,0 +1,150 @@ + + +

Change History

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

Released On

+

Description

+

2022-10-30

+
  • Added description of error codes CTS.0201, CTS.0400, CTS.0401, CTS.0402, CTS.0403, CTS.0404, CTS.0407, CTS.0410 and CTS.0411 in Error Code Description.
+

2022-07-21

+

This release incorporates the following changes:

+

Added Creating a Key Event Notification.

+

Added Modifying a Key Event Notification.

+

Added Deleting a Key Event Notification.

+

Added Querying a Key Event Notification.

+

2021-02-25

+

This release incorporates the following changes:

+ +

2020-04-30

+

This release incorporates the following changes:

+

Added descriptions of the parameters domain_id, is_support_trace_files_encryption, create_time, and message to the Parameter in the response table in Creating a Tracker, Modifying a Tracker, and Querying a Tracker. Deleted SMN-related content.

+

2018-09-30

+

This release incorporates the following changes:

+

Added section API Version Management to support the queries of API versions.

+

2018-05-10

+

This release incorporates the following changes:

+

Accepted in OTC 3.1.

+

2018-04-08

+

This release incorporates the following changes:

+

Optimized descriptions of the parameter tracker_name in sections Tracker Management and Trace Management.

+

2018-03-15

+

This release incorporates the following changes:

+

Optimized the parameter description in sections Creating a Tracker, Modifying a Tracker, and Querying a Tracker.

+

2018-02-25

+

This release incorporates the following changes:

+

In sections Creating a Tracker, Modifying a Tracker, and Querying a Tracker, added the parameters related to the new feature in Key Event Notifications, which is notifications of login activities of specified users.

+

2018-01-30

+

This release incorporates the following changes:

+ +

2017-12-30

+

This release incorporates the following changes:

+

Added descriptions of notifications of native OpenStack API calls in sections Creating a Tracker, Modifying a Tracker, and Querying a Tracker.

+

2017-11-30

+

This release incorporates the following changes:

+

Added parameters in sections Creating a Tracker and Modifying a Tracker. These parameters can be configured to enable notifications of user login activities.

+

2017-10-30

+

This release incorporates the following changes:

+

Added parameters in sections Creating a Tracker and Modifying a Tracker. These parameters can be configured to support the search of management traces using LTS.

+

2017-09-30

+

This release incorporates the following changes:

+
  • Added the description of the Key Event Notification API.
  • Added the OBS error information to section Error Codes.
+

2017-08-30

+

This release incorporates the following changes:

+
  • Added the description of Key Event Notification.
+ +

2017-05-26

+

+

This release incorporates the following changes:

+

In section Querying a Tracker, added the description of API responses.

+

2017-04-28

+

This release incorporates the following changes:

+

In section Trace Management, added the description of Querying Traces v2.0.

+

2017-02-27

+

This release incorporates the following changes:

+
  • In section Querying a Tracker, modified the description of the return code 200.
  • Added the description of the user parameter in section "Querying Traces".
+

2017-02-08

+

This release incorporates the following changes:

+ +

2017-02-03

+

This release incorporates the following changes:

+
  • In section Creating a Tracker, added the return code 400.
  • In section Modifying a Tracker, added the naming rule of bucket_name. Added the description of tracker_name to the URI parameter description.
  • In sections Querying a Tracker and Deleting a Tracker, added the description of tracker_name to the URI parameter description. Deleted the description of parameter tracker_name from the request part in these two APIs.
  • Modified the description of the error code CTS.0023 in Error Codes.
  • Modified descriptions of the parameters trace_id, response, code, message, from, and to in the trace query API. Added descriptions of return code 400 and 404.
+

2017-01-20

+

This release incorporates the following changes:

+

Added the servicetype parameter to the trace query API.

+

2016-12-30

+

This issue is the first official release.

+
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602231.html b/docs/cts/api-ref/en-us_topic_0168602231.html new file mode 100644 index 00000000..5c0c05bd --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602231.html @@ -0,0 +1,17 @@ + + +

API Version Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602232.html b/docs/cts/api-ref/en-us_topic_0168602232.html new file mode 100644 index 00000000..66d195dc --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602232.html @@ -0,0 +1,21 @@ + + +

Tracker Management

+
+
+ + +
+
Parent topic: API Description
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602233.html b/docs/cts/api-ref/en-us_topic_0168602233.html new file mode 100644 index 00000000..ff745673 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602233.html @@ -0,0 +1,12 @@ + + +

Public Parameters

+

+
+
+ +
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602243.html b/docs/cts/api-ref/en-us_topic_0168602243.html new file mode 100644 index 00000000..7cfd36ef --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602243.html @@ -0,0 +1,206 @@ + + +

Querying a Specified API Version

+

Function

This API is used to query a specified API version of CTS.

+
+

URI

GET/{api_version}

+
The URI parameters are described in Table 1. +
+ + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Description

+

api_version

+

Yes

+

API version

+
+
+
+
+

Request

None

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: API Version Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602247.html b/docs/cts/api-ref/en-us_topic_0168602247.html new file mode 100644 index 00000000..489dc3ed --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602247.html @@ -0,0 +1,199 @@ + + +

Querying All API Versions

+

Function

This API is used to query all API versions supported by Cloud Trace Service (CTS).

+
+

URI

GET /

+
+

Request

None

+
+

Response

+
+

Returned Value

+
+
+
+
+
Parent topic: API Version Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602251.html b/docs/cts/api-ref/en-us_topic_0168602251.html new file mode 100644 index 00000000..68acad05 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602251.html @@ -0,0 +1,246 @@ + + +

Creating a Tracker

+

All API URLs described in this section are case-sensitive.

+

Function

This API is used to create a tracker.

+

A tracker will be automatically created when CTS is enabled. All traces recorded by CTS are associated with the tracker. Currently, only one tracker can be created for each tenant in a region.

+

Traces are retained in the CTS console for seven days. For long-term storage, you can enable Object Storage Service (OBS) and deliver real-time operation records to OBS buckets.

+
+

URI

POST /v1.0/{project_id}/tracker

+
The URI parameters are described in Table1 Parameters in the URI. +
+ + + + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+
+
+
+
+

Request

+ +
+

Response

+ +
+

Returned Value

+
+
+
+
+
Parent topic: Tracker Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602252.html b/docs/cts/api-ref/en-us_topic_0168602252.html new file mode 100644 index 00000000..ab6fd321 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602252.html @@ -0,0 +1,500 @@ + + +

Querying Traces (v2.0)

+

Function

This API is used to query records of operations on resources in the last seven days. In v2.0, the request parameter trace_rating is changed to trace_status, and the type of response parameter user is changed to Structure.

+
+

URI

GET /v2.0/{project_id}/{tracker_name}/trace{?trace_id,service_type,resource_type,resource_id,resource_name,trace_name,trace_status,user,limit,from,to,next}

+
The URI parameters are described in Table1 Parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID.

+

tracker_name

+

Yes

+

String

+

Tracker name. Currently, only one tracker is allowed for each tenant. The tracker name is system.

+
+
+
+
+

Request

+ +
+

Response

+ +
+

Returned Value

+ +
+
+
+
+
Parent topic: Trace Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602253.html b/docs/cts/api-ref/en-us_topic_0168602253.html new file mode 100644 index 00000000..1920ec62 --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602253.html @@ -0,0 +1,205 @@ + + +

Querying a Tracker

+

Function

This API is used to query the details of a tracker. The details include the name of the tracker, name of the OBS bucket for storing traces, and prefix of the trace files stored in the OBS bucket.

+
+

URI

GET /v1.0/{project_id}/tracker?tracker_name={tracker_name}

+
The URI parameters are described in Table1 Parameters in the URI. +
+ + + + + + + + + + + + + + + + +
Table 1 Parameters in the URI

Parameter

+

Mandatory

+

Type

+

Description

+

project_id

+

Yes

+

String

+

Project ID

+

tracker_name

+

No

+

String

+

Tracker name.

+

If this parameter is not specified, all trackers will be queried.

+

Currently, only one tracker is allowed for each tenant. The tracker name is system.

+
+
+

It is expected that CTS can support multiple trackers in the future. In this case, if you send a request where the parameter tracker_name is not specified (GET /v1.0/{project_id}/tracker), the response will be in array format. Otherwise, the response will be in object format.

+
+
+
+

Request

+ +
+

Response

+ +
+

Returned Value

+
+
+
+
+
Parent topic: Tracker Management
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602259.html b/docs/cts/api-ref/en-us_topic_0168602259.html new file mode 100644 index 00000000..64a3e21b --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602259.html @@ -0,0 +1,496 @@ + + +

Error Codes

+

Introduction

This section explains the meanings of error codes returned by CTS APIs.

+
+

Example of Returned Error Information

{

+

"error_code": "CTS.0003",

+

"error_msg": "Invalid message body. The message body is empty or invalid."

+

}

+
+

Error Code Description

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

Status Code

+

Error Code

+

Error Message

+

Description

+

Solution

+

400

+

CTS.0001

+

IAM or OBS exception, please check.

+

The IAM or OBS service is abnormal.

+

Contact technical support.

+

403

+

CTS.0002

+

The user fails the authentication or does not have permission to this operation.

+

Authentication failed or you do not have the permissions required.

+

Check your permissions.

+

400

+

CTS.0003

+

Invalid message body. The message body is empty or invalid.

+

The message body is empty or invalid.

+

Check the body content and format.

+

500

+

CTS.0004

+

Data write exception.

+

Failed to write data.

+

Contact technical support.

+

500

+

CTS.0005

+

Data read exception.

+

Failed to read data.

+

Contact technical support.

+

403

+

CTS.0012

+

Invalid project ID. Check whether the project ID is correct.

+

The project ID is invalid.

+

Check whether the project ID is correct.

+

400

+

CTS.0056

+

Failed to create lts trace analysis.

+

Failed to enable trace analysis.

+

Contact technical support.

+

404

+

CTS.0100

+

CTS does not support API interface version query.

+

API version query is not supported in CTS.

+

Contact technical support.

+

400

+

CTS.0200

+

Tracker number is Maximum.

+

The number of trackers has reached the upper limit.

+

Delete or modify unnecessary trackers.

+

400

+

CTS.0201

+

A management tracker has been created.

+

A management tracker has been created.

+

Check whether the management tracker is available.

+

400

+

CTS.0202

+

Invalid message body. Tracker tracker_type must be either system or data.

+

The value of tracker_type is invalid.

+

Change its value to system or data.

+

400

+

CTS.0203

+

Invalid message body. The tracker_name is a string of 1 to 32 characters and cannot start with underscores or hyphens.

+

The value of tracker_name is invalid.

+

Modify its value by referring to the parameter descriptions.

+

400

+

CTS.0204

+

The tracker_name parameter of a management tracker can only be set to system.

+

The tracker_name parameter of a management tracker must be set to system.

+

Modify its value by referring to the parameter descriptions.

+

400

+

CTS.0205

+

Invalid message body. Tracker status is required and value must be either enabled or disabled.

+

The status parameter can only be set to enabled or disabled.

+

Change its value to enabled or disabled.

+

400

+

CTS.0206

+

Invalid message body. The data_bucket is not need.

+

The data_bucket parameter cannot be included in the message body for a management tracker.

+

Delete the data_bucket parameter.

+

400

+

CTS.0207

+

Invalid message body. The tracker_name value cannot be system or system-trace.

+

The tracker_name parameter in the message body cannot be set to system for a data tracker.

+

Change the value of tracker_name to a value other than system.

+

400

+

CTS.0208

+

The tracker already exists.

+

The tracker already exists.

+

Check whether the tracker already exists.

+

400

+

CTS.0209

+

You cannot create different trackers to record the same type of operations on the same OBS bucket.

+

A type of operations on an OBS bucket can be tracked by only one tracker.

+

Change the tracker configurations.

+

400

+

CTS.0210

+

Invalid message body. The OBS bucket for which data operations are to be recorded can not be empty.

+

The OBS bucket to be tracked cannot be empty.

+

Select another bucket or ensure that the bucket is not empty.

+

400

+

CTS.0211

+

Check bucket failed.The bucket is not exist.

+

The OBS bucket to be tracked does not exist.

+

Check whether bucket_name is correctly set.

+

400

+

CTS.0212

+

The tracked OBS bucket can not be modify.

+

The tracked OBS bucket cannot be modified.

+

Withdraw the changes on the OBS bucket.

+

400

+

CTS.0213

+

Invalid message body. The OBS bucket for which data operations are to be recorded and the OBS bucket configured for storing transferred traces cannot be the same.

+

The OBS bucket used for trace transfer cannot be the tracked OBS bucket.

+

Select another OBS bucket for trace transfer.

+

404

+

CTS.0214

+

The tracker does not exist.

+

The tracker does not exist.

+

Check whether the tracker has been deleted.

+

400

+

CTS.0215

+

Check bucket failed.The bucket is already exist.

+

The OBS bucket already exists.

+

Change the value of bucket_name.

+

400

+

CTS.0216

+

Create bucket failed.

+

Failed to create a bucket.

+

Contact technical support.

+

400

+

CTS.0217

+

Set bucket life cycle failed. Contact O&M personnel.

+

Failed to set a lifecycle rule for the OBS bucket.

+

Contact technical support.

+

400

+

CTS.0218

+

Invalid message body. The file_prefix_name is a string of 0 to 64 characters and can only contain uppercase letters, lowercase letters, digits, hyphens, underscores and periods.

+

The value of file_prefix_name is invalid.

+

Modify its value by referring to the parameter descriptions.

+

400

+

CTS.0219

+

The bucket operation cannot be empty.

+

The operation type cannot be empty.

+

Select at least one operation type to track.

+

400

+

CTS.0220

+

KMS is not supported.

+

KMS is not supported.

+

Contact technical support.

+

400

+

CTS.0221

+

The KMS ID is empty.

+

The KMS ID is empty.

+

Check whether the KMS ID is correct.

+

400

+

CTS.0222

+

Failed to obtain key list from KMS.

+

KMS verification failed.

+

Check whether the KMS ID is correct.

+

400

+

CTS.0225

+

The Bucket operation must be WRITE or READ or WRITE,READ.

+

The bucket operation must be write, read, or read/write.

+

Enter a correct parameter.

+

400

+

CTS.0231

+

Invalid bucket name. A bucket name must be a string of 3 to 63 characters, including only lowercase letters, digits, hyphens (-), or periods (.). It must start with a digit or a lowercase letter.

+

Invalid bucket name. A bucket name must contain 3 to 63 characters and start with a digit or a lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.

+

Check whether the bucket name is correct.

+

400

+

CTS.0300

+

Query data failed.

+

Query failed.

+

Try again later or contact technical support.

+

400

+

CTS.0400

+

Notification name is existed already.

+

The key event notification name already exists.

+

Check whether the key event notification already exists.

+

400

+

CTS.0401

+

Invalid message body. The operations parameter value is invalid.

+

The operations parameter is invalid.

+

Check whether the operation parameter is correct.

+

400

+

CTS.0402

+

The Smn topic does not exist.

+

The SMN topic does not exist.

+

Check whether the SMN topic exists.

+

404

+

CTS.0403

+

The notification does not exist.

+

The key event notification does not exist.

+

Check whether the key event notification has been deleted.

+

400

+

CTS.0404

+

State setting failed, check if topicId exists.

+

Failed to enable the key event notification. Check whether the SMN topic has been configured.

+

Check whether the SMN topic has been configured.

+

400

+

CTS.0407

+

The quantity has exceeded the maximum quantity limit.

+

The number of key event notifications exceeds the upper limit.

+

Check whether the number of key event notifications exceeds the quota.

+

400

+

CTS.0410

+

The notification_type must be smn.

+

The key event notification type can only be smn.

+

Check the key operation notification type.

+

400

+

CTS.0411

+

The notification_name invalid.

+

The notification name is invalid.

+

Check whether the notification name is correct.

+
+
+
+
+
+
+
Parent topic: Public Parameters
+
+
+ diff --git a/docs/cts/api-ref/en-us_topic_0168602260.html b/docs/cts/api-ref/en-us_topic_0168602260.html new file mode 100644 index 00000000..5f123cef --- /dev/null +++ b/docs/cts/api-ref/en-us_topic_0168602260.html @@ -0,0 +1,17 @@ + + +

API Description

+
+
+ +
+ diff --git a/docs/cts/api-ref/public_sys-resources/ExpandCollapse.js b/docs/cts/api-ref/public_sys-resources/ExpandCollapse.js new file mode 100644 index 00000000..116ddaab --- /dev/null +++ b/docs/cts/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/cts/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/cts/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/cts/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/cts/api-ref/public_sys-resources/commonltr.css b/docs/cts/api-ref/public_sys-resources/commonltr.css new file mode 100644 index 00000000..c5480b0a --- /dev/null +++ b/docs/cts/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/cts/api-ref/public_sys-resources/commonltr_print.css b/docs/cts/api-ref/public_sys-resources/commonltr_print.css new file mode 100644 index 00000000..a5982314 --- /dev/null +++ b/docs/cts/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/cts/api-ref/public_sys-resources/commonrtl.css b/docs/cts/api-ref/public_sys-resources/commonrtl.css new file mode 100644 index 00000000..f261da75 --- /dev/null +++ b/docs/cts/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/cts/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/cts/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/cts/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/cts/api-ref/public_sys-resources/delta.gif b/docs/cts/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/deltaend.gif b/docs/cts/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/cts/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/cts/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-caution.gif b/docs/cts/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-danger.gif b/docs/cts/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-huawei.gif b/docs/cts/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-note.gif b/docs/cts/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-notice.gif b/docs/cts/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-tip.gif b/docs/cts/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/icon-warning.gif b/docs/cts/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/cts/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/cts/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/cts/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/cts/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/cts/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/cts/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/cts/api-ref/public_sys-resources/popup.js b/docs/cts/api-ref/public_sys-resources/popup.js new file mode 100644 index 00000000..a550862e --- /dev/null +++ b/docs/cts/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/cts/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/cts/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/cts/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/cts/api-ref/topic_300000003.html b/docs/cts/api-ref/topic_300000003.html new file mode 100644 index 00000000..b38a9fc0 --- /dev/null +++ b/docs/cts/api-ref/topic_300000003.html @@ -0,0 +1,21 @@ + + +

Key Event Notification Management

+
+
+ + +
+
Parent topic: API Description
+
+
+