Creating a custom key event notificationPOST https://{endpoint}/v3/{project_id}/notifications
+Example Request
- Creating a complete key event notification
POST https://{endpoint}/v3/{project_id}/notifications
{
- "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": [
- "test1",
- "test2"
- ]
- }, {
- "user_group": "CTS view",
- "user_list": [
- "test3",
- "test4"
- ]
- }
- ],
- "topic_id": "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
+ "notification_name" : "test",
+ "filter" : {
+ "is_support_filter" : true,
+ "rule" : [ "code != 200", "api_version = v1.0", "trace_rating = normal", "trace_type != ApiCall", "resource_id = xxx", "resource_name = xxx" ],
+ "condition" : "OR"
+ },
+ "operation_type" : "complete",
+ "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
}
- - Creating a complete key event notification
POST https://{endpoint}/v3/{project_id}/notifications
+ - Creating a custom key event notification
POST https://{endpoint}/v3/{project_id}/notifications
{
- "notification_name": "test",
- "operation_type": "complete",
- "topic_id": "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
+ "notification_name" : "test",
+ "operation_type" : "customized",
+ "filter" : {
+ "is_support_filter" : true,
+ "rule" : [ "code != 200", "api_version = v1.0", "trace_rating = normal", "trace_type != ApiCall", "resource_id = xxx", "resource_name = xxx" ],
+ "condition" : "OR"
+ },
+ "operations" : [ {
+ "service_type" : "CTS",
+ "resource_type" : "tracker",
+ "trace_names" : [ "createTracker", "deleteTracker" ]
+ }, {
+ "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" : [ "test1", "test2" ]
+ }, {
+ "user_group" : "CTS view",
+ "user_list" : [ "test3", "test4" ]
+ } ],
+ "topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
}
Example Response
Status code: 201
-
The creation is successful.
-
{
+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_name" : "test",
"notification_type" : "smn",
"notify_user_list" : [ {
"user_group" : "admin",
@@ -412,7 +638,7 @@
"operations" : [ {
"resource_type" : "tracker",
"service_type" : "CTS",
- "trace_names" : [ "createTracker", "deleteTraceker" ]
+ "trace_names" : [ "createTracker", "deleteTracker" ]
}, {
"resource_type" : "notification",
"service_type" : "CTS",
@@ -427,58 +653,58 @@
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:test"
}
Status Codes
-
Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-201
+ | 201
|
-The creation is successful.
+ | The creation is successful.
|
-400
+ | 400
|
-The server failed to process the request.
+ | The server failed to process the request.
|
-401
+ | 401
|
-The request is rejected due to authentication failure.
+ | The request is rejected due to authentication failure.
|
-403
+ | 403
|
-The server understood the request but refused to authorize it.
+ | The server understood the request but refused to authorize it.
|
-404
+ | 404
|
-The server failed to find the requested resource or some key event notifications failed to be deleted.
+ | The server failed to find the requested resource or some key event notifications failed to be deleted.
|
-500
+ | 500
|
-The request failed to be executed or some trackers failed to be deleted.
+ | The request failed to be executed or some trackers failed to be deleted.
|
-503
+ | 503
|
-The requested service is unavailable. The client should not repeat the request without modifications.
+ | The requested service is invalid. The client should not repeat the request without modifications.
|
Modifying a Key Event Notification
-FunctionThis API is used to modify a key event notification. The notification ID carried in the request must be valid.
+ FunctionThis API is used to modify a key event notification. The notification ID carried in the request must be valid.
- URIPUT /v3/{project_id}/notifications
+
+ URIPUT /v3/{project_id}/notifications
- Table 1 URI parameterParameter
+Table 1 Path parameterParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.
+ | Project ID. For details, see Obtaining an Account ID and Project ID.
|
Request Parameters
- Table 2 Request body parametersParameter
+Request Parameters
+ Table 2 Request body parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-notification_name
+ | notification_name
|
-Yes
+ | Yes
|
-String
+ | String
|
-Notification name.
+ | Notification name.
|
-operation_type
+ | operation_type
|
-Yes
+ | Yes
|
-String
+ | 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:
-
+ | 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:
+
|
-operations
+ | operations
|
-No
+ | No
|
-Array of Operations objects
+ | Array of Operations objects
|
-Operation list.
+ | Operation list.
|
-notify_user_list
+ | notify_user_list
|
-No
+ | No
|
-Array of NotificationUsers objects
+ | Array of NotificationUsers objects
|
-List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.
+ | List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.
|
-status
+ | status
|
-Yes
+ | Yes
|
-String
+ | String
|
-Notification status. Possible options include enabled and disabled.
-Enumerated values:
-
+ | Notification status. Possible options include enabled and disabled.
+Enumerated values:
+
|
-topic_id
+ | topic_id
|
-No
+ | No
|
-String
+ | 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
+ | Topic URN or function 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 To obtain the function URN, call the FunctionGraph API for querying functions. Example URN: urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test
|
-notification_id
+ | notification_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Notification ID.
+ | Notification ID.
+ |
+
+filter
+ |
+No
+ |
+Filter object
+ |
+Advanced filter of key event notifications.
|
- Table 3 OperationsParameter
+Table 3 OperationsParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-service_type
+ | service_type
|
-Yes
+ | Yes
|
-String
+ | 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.
+ | 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 Cloud Trace Service User Guide. You can click the document link of each cloud service to view its acronym.
|
-resource_type
+ | resource_type
|
-Yes
+ | Yes
|
-String
+ | String
|
-Resource type.
+ | Resource type.
|
-trace_names
+ | trace_names
|
-Yes
+ | Yes
|
-Array of strings
+ | Array of strings
|
-Trace name.
+ | Trace name.
|
Table 4 NotificationUsersParameter
+Table 4 NotificationUsersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-user_group
+ | user_group
|
-Yes
+ | Yes
|
-String
+ | String
|
-IAM user group.
+ | IAM user group.
|
-user_list
+ | user_list
|
-Yes
+ | Yes
|
-Array of strings
+ | Array of strings
|
-IAM user.
- |
-
-
-
- Response ParametersStatus code: 200
-
- Table 5 Response body parametersParameter
- |
-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:
-
- |
-
-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:
-
- |
-
-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:
-
- |
-
-project_id
- |
-String
- |
-Project ID.
- |
-
-create_time
- |
-Long
- |
-Timestamp when a notification was created.
+ | IAM user.
|
- Table 6 OperationsParameter
+Table 5 FilterParameter
|
-Type
+ | Mandatory
|
-Description
+ | Type
+ |
+Description
|
|---|
-service_type
+ | condition
|
-String
+ | Yes
|
-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.
+ | String
+ |
+Relationship between conditions.
+
+Enumerated values:
+AND (default value)
+OR
+
|
-resource_type
+ | is_support_filter
|
-String
+ | Yes
|
-Resource type.
+ | Boolean
+ |
+Whether to enable the advanced filter.
|
-trace_names
+ | rule
|
-Array of strings
+ | Yes
|
-Trace name.
+ | Array of strings
+ |
+Advanced filter criteria rule. Example: key != value. The format is field rule value. - Field options: api_version, code, trace_rating, trace_type, resource_id, or resource_name. - Rule: != or =. - Value: api_version: ^(a-zA-Z0-9_-.){1,64}$; code: 1 to 256 characters; trace_rating: normal, warning, or incident; trace_type: ConsoleAction, ApiCall, or SystemAction; resource_id: 1 to 350 characters; resource_name: 1 to 256 characters.
+ |
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 6 Response body parametersParameter
+ |
+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:
+
+ |
+
+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:
+
+ |
+
+topic_id
+ |
+String
+ |
+Topic URN or function URN. To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2 To obtain the function URN, call the FunctionGraph API for querying functions. Example URN: urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test
+ |
+
+notification_id
+ |
+String
+ |
+Unique notification ID.
+ |
+
+notification_type
+ |
+String
+ |
+Notification type identified based on topic_id. Possible options include SMN (smn) and FunctionGraph (fun).
+Enumerated values:
+
+ |
+
+project_id
+ |
+String
+ |
+Project ID.
+ |
+
+create_time
+ |
+Long
+ |
+Timestamp when a notification was created.
+ |
+
+filter
+ |
+Filter object
+ |
+Advanced filter of key event notifications.
|
- Table 7 NotificationUsersParameter
+Table 7 OperationsParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-user_group
+ | service_type
|
-String
+ | String
|
-IAM user group.
+ | 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 Cloud Trace Service User Guide. You can click the document link of each cloud service to view its acronym.
|
-user_list
+ | resource_type
|
-Array of strings
+ | String
|
-IAM user.
+ | Resource type.
+ |
+
+trace_names
+ |
+Array of strings
+ |
+Trace name.
|
Status code: 400
-Table 8 Response body parametersParameter
+Table 8 NotificationUsersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | user_group
|
-String
+ | String
|
-Error code. Format: CTS.XXX.
+ | IAM user group.
|
-error_msg
+ | user_list
|
-String
+ | Array of strings
|
-Error description.
+ | IAM user.
+ |
+
+
+
+ Table 9 FilterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+condition
+ |
+String
+ |
+Relationship between conditions.
+
+Enumerated values:
+AND (default value)
+OR
+
+ |
+
+is_support_filter
+ |
+Boolean
+ |
+Whether to enable the advanced filter.
+ |
+
+rule
+ |
+Array of strings
+ |
+Advanced filter criteria rule. Example: key != value. The format is field rule value. - Field options: api_version, code, trace_rating, trace_type, resource_id, or resource_name. - Rule: != or =. - Value: api_version: ^(a-zA-Z0-9_-.){1,64}$; code: 1 to 256 characters; trace_rating: normal, warning, or incident; trace_type: ConsoleAction, ApiCall, or SystemAction; resource_id: 1 to 350 characters; resource_name: 1 to 256 characters.
+ |
+
+
+
+ Status code: 400
+
+Table 10 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 401
+
+Table 11 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 403
+
+Table 12 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 404
+
+Table 13 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 500
+
+Table 14 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 503
+
+Table 15 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
|
Example RequestModifying a key event notification
- PUT https://{endpoint}/v3/{project_id}/notifications
+Example RequestModify a key event notification.
+ PUT https://{endpoint}/v3/{project_id}/notifications
{
"notification_id" : "6d4a09bb-aa8e-40db-9e87-0d5e203823a8",
@@ -371,7 +620,7 @@
"operations" : [ {
"service_type" : "CTS",
"resource_type" : "tracker",
- "trace_names" : [ "createTracker", "deleteTraceker" ]
+ "trace_names" : [ "createTracker", "deleteTracker" ]
}, {
"service_type" : "CTS",
"resource_type" : "notification",
@@ -392,16 +641,16 @@
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:foo"
}
Example ResponseStatus code: 200
- The notification is modified.
- {
+Example ResponseStatus 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" ]
+ "trace_names" : [ "createTracker", "deleteTracker" ]
}, {
"service_type" : "CTS",
"resource_type" : "notification",
@@ -425,58 +674,58 @@
"topic_id" : "urn:smn:{regionid}:24edf66e79d04187acb99a463e610764:foo"
}
Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-The notification is modified.
+ | The notification is modified.
|
-400
+ | 400
|
-The server failed to process the request.
+ | The server failed to process the request.
|
-401
+ | 401
|
-The request is rejected due to authentication failure.
+ | The request is rejected due to authentication failure.
|
-403
+ | 403
|
-The server understood the request but refused to authorize it.
+ | The server understood the request but refused to authorize it.
|
-404
+ | 404
|
-The server failed to find the requested resource or some key event notifications failed to be deleted.
+ | The server failed to find the requested resource or some key event notifications failed to be deleted.
|
-500
+ | 500
|
-The request failed to be executed or some trackers failed to be deleted.
+ | The request failed to be executed or some trackers failed to be deleted.
|
-503
+ | 503
|
-The requested service is unavailable. The client should not repeat the request without modifications.
+ | The requested service is invalid. The client should not repeat the request without modifications.
|
Deleting a Key Event Notification
-FunctionThis API is used to delete a key event notification.
+ FunctionThis API is used to delete a key event notification.
- URIDELETE /v3/{project_id}/notifications
+
+ URIDELETE /v3/{project_id}/notifications
- Table 1 URI parameterParameter
+Table 1 Path parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.
+ | Project ID. For details, see Obtaining an Account ID and Project ID.
|
Table 2 Query parameterParameter
+Table 2 Query parameterParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-notification_id
+ | notification_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Notification ID. To batch delete notifications, enter multiple notification IDs separated by commas (,), for example, notification_id="xxx1,ccc2".
+ | Notification ID. To batch delete notifications, enter multiple notification IDs separated by commas (,), for example, notification_id="xxx1,ccc2".
|
Request ParametersNone
+
- Response ParametersStatus code: 400
+ Response ParametersStatus code: 400
- Table 3 Response body parametersParameter
+Table 3 Response body parametersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | error_code
|
-String
+ | String
|
-Error code. Format: CTS.XXX.
+ | Error code. Format: CTS.XXX.
|
-error_msg
+ | error_msg
|
-String
+ | String
|
-Error description.
+ | Error message.
+ |
+
+
+
+ Status code: 401
+
+Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 403
+
+Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 404
+
+Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 500
+
+Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 503
+
+Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
|
Example RequestNone
+
- Example ResponseNone
+
- Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-204
+ | 204
|
-The deletion is successful.
+ | The deletion is successful.
|
-400
+ | 400
|
-The server failed to process the request.
+ | The server failed to process the request.
|
-401
+ | 401
|
-The request is rejected due to authentication failure.
+ | The request is rejected due to authentication failure.
|
-403
+ | 403
|
-The server understood the request but refused to authorize it.
+ | The server understood the request but refused to authorize it.
|
-404
+ | 404
|
-The server failed to find the requested resource or some key event notifications failed to be deleted.
+ | The server failed to find the requested resource or some key event notifications failed to be deleted.
|
-500
+ | 500
|
-The request failed to be executed or some trackers failed to be deleted.
+ | The request failed to be executed or some trackers failed to be deleted.
|
-503
+ | 503
|
-The requested service is unavailable. The client should not repeat the request without modifications.
+ | The requested service is invalid. The client should not repeat the request without modifications.
|
Querying a Key Event Notification
-FunctionThis API is used to query a key event notification.
+ FunctionThis API is used to query a key event notification.
- URIGET /v3/{project_id}/notifications/{notification_type}
+
+ URIGET /v3/{project_id}/notifications/{notification_type}
- Table 1 URI parametersParameter
+Table 1 Path parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-project_id
+ | project_id
|
-Yes
+ | Yes
|
-String
+ | String
|
-Project ID. For details, see section "Obtaining the Account ID and Project ID" in Cloud Trace Service API Reference.
+ | Project ID. For details, see Obtaining an Account ID and Project ID.
|
-notification_type
+ | notification_type
|
-Yes
+ | Yes
|
-String
+ | String
|
-Notification type.
-Enumerated value:
-
+ | Notification type. - smn: Simple Message Notification (SMN). - fun: FunctionGraph.
+Enumerated values:
+
|
Table 2 Query parameterParameter
+Table 2 Query parametersParameter
|
-Mandatory
+ | Mandatory
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-notification_name
+ | notification_name
|
-No
+ | No
|
-String
+ | String
|
-Notification name. If this parameter is not specified, all key event notifications configured in the current tenant account are returned.
+ | Notification name. If this parameter is not specified, all key event notifications configured in the current tenant account are returned.
|
Request ParametersNone
+
- Response ParametersStatus code: 200
+ Response ParametersStatus code: 200
- Table 3 Response body parameterParameter
+
-Table 4 NotificationsResponseBodyParameter
+Table 4 NotificationsResponseBodyParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-notification_name
+ | notification_name
|
-String
+ | String
|
-Notification name.
+ | Notification name.
|
-operation_type
+ | operation_type
|
-String
+ | 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:
-
+ | 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:
+
|
-operations
+ | operations
|
-Array of Operations objects
+ | Array of Operations objects
|
-Operation list.
+ | Operation list.
|
-notify_user_list
+ | notify_user_list
|
-Array of NotificationUsers objects
+ | Array of NotificationUsers objects
|
-List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.
+ | List of users whose operations will trigger notifications. Currently, up to 50 users in 10 user groups can be configured.
|
-status
+ | status
|
-String
+ | String
|
-Notification status. Possible options include enabled and disabled.
-Enumerated values:
-
+ | Notification status. Possible options include enabled and disabled.
+Enumerated values:
+
|
-topic_id
+ | topic_id
|
-String
+ | String
|
-Topic URN.
-- To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2
+ | Topic URN or function URN. To obtain the topic_urn, call the SMN API for querying topics. Example URN: urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:test_topic_v2 To obtain the function URN, call the FunctionGraph API for querying functions. Example URN: urn:fss:xxxxxxxxx:7aad83af3e8d42e99ac194e8419e2c9b:function:default:test
|
-notification_id
+ | notification_id
|
-String
+ | String
|
-Unique notification ID.
+ | Unique notification ID.
|
-notification_type
+ | notification_type
|
-String
+ | String
|
-Notification type.
-Enumerated value:
-
+ | Notification type identified based on topic_id. Possible options include SMN (smn) and FunctionGraph (fun).
+Enumerated values:
+
|
-project_id
+ | project_id
|
-String
+ | String
|
-Project ID.
+ | Project ID.
|
-create_time
+ | create_time
|
-Long
+ | Long
|
-Timestamp when a notification was created.
+ | Timestamp when a notification was created.
+ |
+
+filter
+ |
+Filter object
+ |
+Advanced filter of key event notifications.
|
Table 5 OperationsParameter
+Table 5 OperationsParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-service_type
+ | service_type
|
-String
+ | 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.
+ | 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 Cloud Trace Service User Guide. You can click the document link of each cloud service to view its acronym.
|
-resource_type
+ | resource_type
|
-String
+ | String
|
-Resource type.
+ | Resource type.
|
-trace_names
+ | trace_names
|
-Array of strings
+ | Array of strings
|
-Trace name.
+ | Trace name.
|
Table 6 NotificationUsersParameter
+Table 6 NotificationUsersParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-user_group
+ | user_group
|
-String
+ | String
|
-IAM user group.
+ | IAM user group.
|
-user_list
+ | user_list
|
-Array of strings
+ | Array of strings
|
-IAM user.
+ | IAM user.
|
Status code: 400
-Table 7 Response body parametersParameter
+Table 7 FilterParameter
|
-Type
+ | Type
|
-Description
+ | Description
|
|---|
-error_code
+ | condition
|
-String
+ | String
|
-Error code. Format: CTS.XXX.
+ | Relationship between conditions.
+
+Enumerated values:
+AND (default value)
+OR
+
|
-error_msg
+ | is_support_filter
|
-String
+ | Boolean
|
-Error description.
+ | Whether to enable the advanced filter.
+ |
+
+rule
+ |
+Array of strings
+ |
+Advanced filter criteria rule. Example: key != value. The format is field rule value. - Field options: api_version, code, trace_rating, trace_type, resource_id, or resource_name. - Rule: != or =. - Value: api_version: ^(a-zA-Z0-9_-.){1,64}$; code: 1 to 256 characters; trace_rating: normal, warning, or incident; trace_type: ConsoleAction, ApiCall, or SystemAction; resource_id: 1 to 350 characters; resource_name: 1 to 256 characters.
+ |
+
+
+
+ Status code: 400
+
+Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 401
+
+Table 9 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 403
+
+Table 10 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 404
+
+Table 11 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 500
+
+Table 12 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+ Status code: 503
+
+Table 13 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
|
Example RequestNone
+
- Example ResponseStatus code: 200
- The query is successful.
- {
+Example ResponseStatus code: 200
+ The query is successful.
+ {
"notifications" : [ {
"create_time" : 1633933167385,
"notify_user_list" : [ {
@@ -313,58 +504,58 @@
} ]
}
Status Codes
- Status Code
+Status Codes
+ Status Code
|
-Description
+ | Description
|
|---|
-200
+ | 200
|
-The query is successful.
+ | The query is successful.
|
-400
+ | 400
|
-The server failed to process the request.
+ | The server failed to process the request.
|
-401
+ | 401
|
-The request is rejected due to authentication failure.
+ | The request is rejected due to authentication failure.
|
-403
+ | 403
|
-The server understood the request but refused to authorize it.
+ | The server understood the request but refused to authorize it.
|
-404
+ | 404
|
-The server failed to find the requested resource or some key event notifications failed to be deleted.
+ | The server failed to find the requested resource or some key event notifications failed to be deleted.
|
-500
+ | 500
|
-The request failed to be executed or some trackers failed to be deleted.
+ | The request failed to be executed or some trackers failed to be deleted.
|
-503
+ | 503
|
-The requested service is unavailable. The client should not repeat the request without modifications.
+ | The requested service is invalid. The client should not repeat the request without modifications.
|
Tracker Management
+
+
+
diff --git a/docs/cts/api-ref/cts_api_0321.html b/docs/cts/api-ref/cts_api_0321.html
new file mode 100644
index 00000000..9a060be7
--- /dev/null
+++ b/docs/cts/api-ref/cts_api_0321.html
@@ -0,0 +1,592 @@
+
+
+Creating a Tracker
+FunctionWhen you enable CTS, a tracker is automatically created to associate with the cloud services you are using and record all operations on the services. A management tracker can be created by an account 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.
+
+ URIPOST /v3/{project_id}/tracker
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+tracker_type
+ |
+Yes
+ |
+String
+ |
+Tracker type. The value can be system (management tracker).
+Enumerated values:
+
+ |
+
+tracker_name
+ |
+Yes
+ |
+String
+ |
+Tracker name. When tracker_type is set to system, the default value system is used.
+ |
+
+is_lts_enabled
+ |
+No
+ |
+Boolean
+ |
+Whether to enable trace analysis.
+ |
+
+obs_info
+ |
+No
+ |
+TrackerObsInfo object
+ |
+Configurations of an OBS bucket to which traces will be transferred.
+ |
+
+
+
+
+
+ Table 3 TrackerObsInfoParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bucket_name
+ |
+No
+ |
+String
+ |
+OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
+ |
+
+file_prefix_name
+ |
+No
+ |
+String
+ |
+Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
+ |
+
+is_obs_created
+ |
+No
+ |
+Boolean
+ |
+Whether an OBS bucket is created. If the value is true, an OBS bucket will be created to store trace files. If the value is false, trace files will be stored in an existing OBS bucket.
+ |
+
+compress_type
+ |
+No
+ |
+String
+ |
+Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP.
+Enumerated values:
+
+ |
+
+is_sort_by_service
+ |
+No
+ |
+Boolean
+ |
+Whether to sort the path by cloud service. If this option is enabled, the cloud service name is added to the transfer file path. The default value is true.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 201
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Unique tracker ID.
+ |
+
+create_time
+ |
+Long
+ |
+Timestamp when the tracker was created.
+ |
+
+lts
+ |
+Lts object
+ |
+Detail about trace analysis.
+ |
+
+tracker_type
+ |
+String
+ |
+Tracker type. The value can be system (management tracker).
+Enumerated values:
+
+ |
+
+domain_id
+ |
+String
+ |
+Account ID. For details, see Obtaining an Account ID and Project ID.
+ |
+
+project_id
+ |
+String
+ |
+Project ID.
+ |
+
+tracker_name
+ |
+String
+ |
+Tracker name. The default value is system.
+ |
+
+status
+ |
+String
+ |
+Tracker status. The value can be enabled, disabled, or error. If the value is set to error, the detail field is required for specifying the source of the error.
+Enumerated values:
+
+ |
+
+detail
+ |
+String
+ |
+This parameter is returned only when the tracker status is error. It indicates the cause of the abnormal status, and its value can be bucketPolicyError, noBucket, or arrears.
+ |
+
+obs_info
+ |
+ObsInfo object
+ |
+Information about the bucket to which traces are transferred.
+ |
+
+
+
+
+
+ Table 5 ManagementEventSelectorParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+exclude_service
+ |
+Array of strings
+ |
+Cloud services whose traces will not be transferred. Currently, the value can only be set to KMS, indicating that the createDatakey traces of KMS will not be transferred.
+ |
+
+
+
+
+
+ Table 6 LtsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+is_lts_enabled
+ |
+Boolean
+ |
+Specifies whether to enable the LTS search function.
+ |
+
+log_group_name
+ |
+String
+ |
+Name of the log group that CTS creates in LTS.
+ |
+
+log_topic_name
+ |
+String
+ |
+Specifies the name of the log topic that CTS creates in LTS.
+ |
+
+
+
+
+
+ Table 7 ObsInfoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bucket_name
+ |
+String
+ |
+OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
+ |
+
+file_prefix_name
+ |
+String
+ |
+Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
+ |
+
+is_obs_created
+ |
+Boolean
+ |
+Whether the OBS bucket is automatically created by the tracker.
+ |
+
+compress_type
+ |
+String
+ |
+Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP.
+Enumerated values:
+
+ |
+
+is_sort_by_service
+ |
+Boolean
+ |
+Whether to sort the path by cloud service. If this option is enabled, the cloud service name is added to the transfer file path. The default value is true.
+ |
+
+
+
+
+ Status code: 400
+
+ Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 401
+
+ Table 9 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 403
+
+ Table 10 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 404
+
+ Table 11 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 500
+
+ Table 12 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 503
+
+ Table 13 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+
+ Example Request- Creating a management tracker
POST https://{endpoint}/v3/{project_id}/tracker
+
+{
+ "tracker_type" : "system",
+ "tracker_name" : "system",
+ "obs_info" : {
+ "is_obs_created" : false,
+ "bucket_name" : "test-data-tracker",
+ "file_prefix_name" : "11"
+ },
+ "is_lts_enabled" : true,
+ "is_support_trace_files_encryption" : true,
+ "kms_id" : "13a4207c-7abe-4b68-8510-16b84c3b5504",
+ "is_support_validate" : true
+}
+
+
+ Example ResponseStatus code: 201
+ The request is successful.
+ {
+ "id" : "2e6fa9b8-8c6e-456d-b5d3-77be972d220b",
+ "create_time" : 1587958482923,
+ "domain_id" : "aexxxxxxxx4d4fb4bexxxxxxx791fbf",
+ "obs_info" : {
+ "is_obs_created" : false,
+ "bucket_name" : "test-bucket",
+ "is_authorized_bucket" : false,
+ "file_prefix_name" : "11",
+ "bucket_lifecycle" : 30
+ },
+ "project_id" : "bb1xxxxxxxxe4f498cbxxxxxxxx35634",
+ "lts" : {
+ "is_lts_enabled" : true,
+ "log_group_name" : "CTS",
+ "log_topic_name" : "system-trace"
+ },
+ "is_support_validate" : true,
+ "tracker_name" : "system",
+ "tracker_type" : "system",
+ "status" : "enabled"
+}
+
+ Status Code
+ Status Code
+ |
+Description
+ |
+
|---|
+
+201
+ |
+The request 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 requested resource does not exist.
+ |
+
+500
+ |
+Failed to complete the request because of an internal service error.
+ |
+
+503
+ |
+The requested service is invalid. The client should not repeat the request without modifications.
+ |
+
+
+
+
+
+
+ Modifying a Tracker
+FunctionThis API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, trace search and analysis using LTS, trace file integrity check, and tracker enablement or disablement. Modifying tracker parameters does not affect the existing operation records. After the modification is complete, the new rules are immediately applied to operation recording.
+
+ URIPUT /v3/{project_id}/tracker
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+tracker_type
+ |
+Yes
+ |
+String
+ |
+Tracker type. The value can be system (management tracker).
+Enumerated values:
+
+ |
+
+tracker_name
+ |
+Yes
+ |
+String
+ |
+Tracker name. When tracker_type is set to system, the default value system is used.
+ |
+
+status
+ |
+No
+ |
+String
+ |
+Tracker status. The value can be enabled or disabled. If you change the value to disabled, the tracker stops recording traces.
+Enumerated values:
+
+ |
+
+is_lts_enabled
+ |
+No
+ |
+Boolean
+ |
+Whether to enable trace analysis.
+ |
+
+obs_info
+ |
+No
+ |
+TrackerObsInfo object
+ |
+Configurations of an OBS bucket to which traces will be transferred.
+ |
+
+
+
+
+
+ Table 3 TrackerObsInfoParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bucket_name
+ |
+No
+ |
+String
+ |
+OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
+ |
+
+file_prefix_name
+ |
+No
+ |
+String
+ |
+Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
+ |
+
+is_obs_created
+ |
+No
+ |
+Boolean
+ |
+Whether an OBS bucket is created. If the value is true, an OBS bucket will be created to store trace files. If the value is false, trace files will be stored in an existing OBS bucket.
+ |
+
+compress_type
+ |
+No
+ |
+String
+ |
+Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP.
+Enumerated values:
+
+ |
+
+is_sort_by_service
+ |
+No
+ |
+Boolean
+ |
+Whether to sort the path by cloud service. If this option is enabled, the cloud service name is added to the transfer file path. The default value is true.
+ |
+
+
+
+
+
+ Response ParametersStatus code: 400
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 401
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 403
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 404
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 500
+
+ Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 503
+
+ Table 9 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+
+ Example Request- Modifying a management tracker
PUT https://{endpoint}/v3/{project_id}/tracker
+
+{
+ "tracker_type" : "system",
+ "tracker_name" : "system",
+ "obs_info" : {
+ "is_obs_created" : false,
+ "bucket_name" : "test-data-tracker",
+ "file_prefix_name" : "11"
+ },
+ "is_lts_enabled" : false,
+ "is_support_trace_files_encryption" : false,
+ "kms_id" : "",
+ "is_support_validate" : false,
+ "status" : "enabled"
+}
+
+
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+The request 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.
+ |
+
+500
+ |
+Failed to complete the request because of an internal service error.
+ |
+
+503
+ |
+The requested service is invalid. The client should not repeat the request without modifications.
+ |
+
+
+
+
+
+
+ Querying a Tracker
+FunctionAfter CTS is enabled, you can view details about the tracker on the Tracker page. 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.
+
+ URIGET /v3/{project_id}/trackers
+
+
+
+ Table 2 Query parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+tracker_name
+ |
+No
+ |
+String
+ |
+Tracker name. If this parameter is not specified, all trackers of a tenant will be queried.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+trackers
+ |
+Array of TrackerResponseBody objects
+ |
+List of tracker information.
+ |
+
+
+
+
+
+ Table 4 TrackerResponseBodyParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Unique tracker ID.
+ |
+
+create_time
+ |
+Long
+ |
+Timestamp when the tracker was created.
+ |
+
+lts
+ |
+Lts object
+ |
+Detail about trace analysis.
+ |
+
+tracker_type
+ |
+String
+ |
+Tracker type. The value can be system (management tracker).
+Enumerated values:
+
+ |
+
+domain_id
+ |
+String
+ |
+Account ID. For details, see Obtaining an Account ID and Project ID.
+ |
+
+project_id
+ |
+String
+ |
+Project ID.
+ |
+
+tracker_name
+ |
+String
+ |
+Tracker name. The default value is system.
+ |
+
+status
+ |
+String
+ |
+Tracker status. The value can be enabled, disabled, or error. If the value is set to error, the detail field is required for specifying the source of the error.
+Enumerated values:
+
+ |
+
+detail
+ |
+String
+ |
+This parameter is returned only when the tracker status is error. It indicates the cause of the abnormal status, and its value can be bucketPolicyError, noBucket, or arrears.
+ |
+
+obs_info
+ |
+ObsInfo object
+ |
+Information about the bucket to which traces are transferred.
+ |
+
+group_id
+ |
+String
+ |
+LTS log group ID.
+ |
+
+stream_id
+ |
+String
+ |
+LTS log stream ID.
+ |
+
+
+
+
+
+ Table 5 LtsParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+is_lts_enabled
+ |
+Boolean
+ |
+Specifies whether to enable the LTS search function.
+ |
+
+log_group_name
+ |
+String
+ |
+Name of the log group that CTS creates in LTS.
+ |
+
+log_topic_name
+ |
+String
+ |
+Specifies the name of the log topic that CTS creates in LTS.
+ |
+
+
+
+
+
+ Table 6 ObsInfoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bucket_name
+ |
+String
+ |
+OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
+ |
+
+file_prefix_name
+ |
+String
+ |
+Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
+ |
+
+is_obs_created
+ |
+Boolean
+ |
+Whether the OBS bucket is automatically created by the tracker.
+ |
+
+compress_type
+ |
+String
+ |
+Compression type. The value can be JSON (no compression) or GZIP (compression). The default format is GZIP.
+Enumerated values:
+
+ |
+
+is_sort_by_service
+ |
+Boolean
+ |
+Whether to sort the path by cloud service. If this option is enabled, the cloud service name is added to the transfer file path. The default value is true.
+ |
+
+
+
+
+ Status code: 400
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 401
+
+ Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 403
+
+ Table 9 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 500
+
+ Table 10 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 503
+
+ Table 11 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+
+ Example RequestGET https://{endpoint}/v3/{project_id}/trackers?tracker_name=system
+
+ Example ResponseStatus code: 200
+ The request is successful.
+ {
+ "trackers" : [ {
+ "create_time" : 1589886034121,
+ "stream_id" : "4a1ef2b6-d79a-4dc6-90f0-48151cd5491b",
+ "group_id" : "26fa12ac-75f7-42ed-8118-ab9f2263042f",
+ "obs_info" : {
+ "is_obs_created" : false,
+ "bucket_name" : "",
+ "is_authorized_bucket" : false,
+ "file_prefix_name" : "",
+ },
+ "lts" : {
+ "log_group_name" : "CTS",
+ "is_lts_enabled" : true,
+ "log_topic_name" : "system-trace"
+ },
+ "tracker_type" : "system",
+ "domain_id" : "2306579dc99f4c8690b14b68e734fcd9",
+ "project_id" : "24edf66e79d04187acb99a463e610764",
+ "tracker_name" : "system",
+ "id" : "ebf8d1c3-762b-4ce3-b316-6b1aa32f8be3",
+ "status" : "enabled"
+ }
+}
+
+ Status Code
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+The request 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.
+ |
+
+500
+ |
+Failed to complete the request because of an internal service error.
+ |
+
+503
+ |
+The requested service is invalid. The client should not repeat the request without modifications.
+ |
+
+
+
+
+
+
+ Deleting a Tracker
+FunctionThis 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 traces.
+
+ URIDELETE /v3/{project_id}/trackers
+
+
+
+ Table 2 Query parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+tracker_name
+ |
+No
+ |
+String
+ |
+Tracker name. If this parameter is not specified, all trackers of the current tenant account will be deleted.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 400
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 401
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 403
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 404
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 500
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 503
+
+ Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+
+ Example RequestDELETE https://{endpoint}/v3/{project_id}/trackers?tracker_name=system
+
+
+ Status Code
+ 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 trackers failed to be deleted.
+ |
+
+500
+ |
+The request failed to be executed or some trackers failed to be deleted.
+ |
+
+503
+ |
+The requested service is invalid. The client should not repeat the request without modifications.
+ |
+
+
+
+
+
+
+ Other APIs
+
+
+
diff --git a/docs/cts/api-ref/cts_api_0331.html b/docs/cts/api-ref/cts_api_0331.html
new file mode 100644
index 00000000..508032c9
--- /dev/null
+++ b/docs/cts/api-ref/cts_api_0331.html
@@ -0,0 +1,322 @@
+
+
+Querying Tenant Quota Information
+FunctionThis API is used to querying tenant quota Information.
+
+ URIGET /v3/{project_id}/quotas
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 2 Response body parameterParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resources
+ |
+Array of Quota objects
+ |
+List of tracker information.
+ |
+
+
+
+
+
+ Table 3 QuotaParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+type
+ |
+String
+ |
+Quota resource type.
+ |
+
+used
+ |
+Long
+ |
+Number of used resources.
+ |
+
+quota
+ |
+Long
+ |
+Total number of resources.
+ |
+
+
+
+
+ Status code: 400
+
+ Table 4 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 401
+
+ Table 5 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 403
+
+ Table 6 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 404
+
+ Table 7 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 500
+
+ Table 8 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+ Status code: 503
+
+ Table 9 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+error_code
+ |
+String
+ |
+Error code. Format: CTS.XXX.
+ |
+
+error_msg
+ |
+String
+ |
+Error message.
+ |
+
+
+
+
+
+ Example RequestGET https://{endpoint}/v3/{project_id}/quotas
+
+ Example ResponseStatus code: 200
+ The request is successful.
+ {
+ "resources": [
+ {
+ "quota": 1,
+ "used": 1,
+ "type": "system_tracker"
+ },
+ {
+ "quota": 100,
+ "used": 2,
+ "type": "smn_notification"
+ }
+ ]
+}
+
+ Status Code
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+The request 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 requested resource does not exist.
+ |
+
+500
+ |
+Failed to complete the request because of an internal service error.
+ |
+
+503
+ |
+The requested service is invalid. The client should not repeat the request without modifications.
+ |
+
+
+
+
+
+
+ Querying Traces (v2.0)
+FunctionThis API is used to query records of operations on resources in the last seven days.
+
+ URIGET /v2.0/{project_id}/{tracker_name}/trace
+
+ Table 1 Path parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
+ |
+
+tracker_name
+ |
+Yes
+ |
+String
+ |
+Tracker name. Currently, only one tracker is allowed for each tenant. The tracker name is system.
+ |
+
+
+
+
+
+ Table 2 Query parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+service_type
+ |
+No
+ |
+String
+ |
+Type of a cloud service whose traces are to be queried. 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 Cloud Trace Service User Guide. You can click the document link of each cloud service to view its name abbreviation.
+ |
+
+user
+ |
+No
+ |
+String
+ |
+Name of the user whose traces are to be queried.
+ |
+
+from
+ |
+No
+ |
+Long
+ |
+UTC millisecond timestamp of the query start time. The value contains 13 digits and the default value is the timestamp of the last hour. Traces generated after the specified timestamp will be queried. The parameters from and to should be used together.
+ |
+
+limit
+ |
+No
+ |
+Integer
+ |
+Number of traces to query. The default value is 10 and the maximum value is 200.
+ |
+
+next
+ |
+No
+ |
+String
+ |
+This parameter is used to query traces generated earlier than its specified value. The value can be that of marker in the response. next can be used with from and to. Traces generated in the overlap of the two time ranges specified respectively by next and by from and to will be returned.
+ |
+
+resource_id
+ |
+No
+ |
+String
+ |
+ID of a cloud resource whose traces are to be queried.
+ |
+
+resource_name
+ |
+No
+ |
+String
+ |
+Name of a resource whose traces are to be queried. The value can contain uppercase letters.
+ |
+
+resource_type
+ |
+No
+ |
+String
+ |
+Type of a resource whose traces are to be queried.
+ |
+
+to
+ |
+No
+ |
+Long
+ |
+UTC millisecond timestamp of the query end time. The value contains 13 digits and the default value is the timestamp of the current time. Traces generated before the specified timestamp will be queried. The parameters to and from should be used together.
+ |
+
+trace_id
+ |
+No
+ |
+String
+ |
+Trace ID. If this parameter is specified, other query criteria will not take effect.
+ |
+
+trace_name
+ |
+No
+ |
+String
+ |
+Trace name. The value can contain uppercase letters.
+ |
+
+trace_rating
+ |
+No
+ |
+String
+ |
+Trace status. The value can be normal, warning, or incident.
+ |
+
+
+
+
+
+
+ Response ParametersStatus code: 200
+
+ Table 3 Response body parametersParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+traces
+ |
+Array of Traces objects
+ |
+List of returned traces.
+ |
+
+meta_data
+ |
+MetaData object
+ |
+Number of returned traces and the marker.
+ |
+
+
+
+
+
+ Table 4 TracesParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+resource_id
+ |
+String
+ |
+ID of a cloud resource on which the recorded operation was performed.
+ |
+
+trace_name
+ |
+String
+ |
+Trace name. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). It must start with a letter.
+ |
+
+trace_rating
+ |
+String
+ |
+Trace status. The value can be normal, warning, or incident.
+Value:
+
+ |
+
+trace_type
+ |
+String
+ |
+Trace source. The value can be ApiCall, ConsoleAction, or SystemAction.
+ |
+
+request
+ |
+String
+ |
+Request of an operation on resources.
+ |
+
+response
+ |
+String
+ |
+Response to a user request, that is, the returned information for an operation on resources.
+ |
+
+code
+ |
+String
+ |
+HTTP status code returned by the associated API.
+ |
+
+api_version
+ |
+String
+ |
+Version of the API called in a trace.
+ |
+
+message
+ |
+String
+ |
+Remarks added by other cloud services to a trace.
+ |
+
+record_time
+ |
+Long
+ |
+Timestamp when a trace was recorded by CTS.
+ |
+
+trace_id
+ |
+String
+ |
+Trace ID. The value is the UUID generated by the system.
+ |
+
+time
+ |
+Long
+ |
+Timestamp when a trace was generated.
+ |
+
+user
+ |
+UserInfo object
+ |
+Information of the user who performed the operation that triggered the trace.
+ |
+
+service_type
+ |
+String
+ |
+Type of a cloud service whose traces are to be queried. 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 Cloud Trace Service User Guide. You can click the document link of each cloud service to view its name abbreviation.
+ |
+
+resource_type
+ |
+String
+ |
+Type of the resource on which the operation was performed.
+ |
+
+source_ip
+ |
+String
+ |
+IP address of the tenant who performed the operation that triggered the trace.
+ |
+
+resource_name
+ |
+String
+ |
+Name of a resource on which the recorded operation was performed.
+ |
+
+request_id
+ |
+String
+ |
+Request ID.
+ |
+
+location_info
+ |
+String
+ |
+Additional information required for fault locating after a request error.
+ |
+
+endpoint
+ |
+String
+ |
+Endpoint in the details page URL of the cloud resource on which the recorded operation was performed.
+ |
+
+resource_url
+ |
+String
+ |
+Details page URL (excluding the endpoint) of the cloud resource on which the recorded operation was performed.
+ |
+
+
+
+
+
+ Table 5 UserInfoParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Account ID. For details about how to obtain an account ID, see Obtaining an Account ID.
+ |
+
+name
+ |
+String
+ |
+Account name.
+ |
+
+domain
+ |
+BaseUser object
+ |
+Domain information of the user who performed the operation generating the trace.
+ |
+
+
+
+
+
+ Table 6 BaseUserParameter
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+id
+ |
+String
+ |
+Account ID. For details about how to obtain an account ID, see Obtaining an Account ID.
+ |
+
+name
+ |
+String
+ |
+Account name.
+ |
+
+
+
+
+
+
+
+ Example RequestGET https://{endpoint}/v2.0/{project_id}/{tracker_name}/trace?limit=11&to=1479095278000&from=1478490478000&trace_name=createTracker&resource_type=tracker&service_type=CTS
+
+ Example ResponseStatus code: 200
+ The request is successful.
+ {
+ "meta_data" : {
+ "count" : 2,
+ "marker" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
+ },
+ "traces" : [ {
+ "time" : 1472148708232,
+ "user" : {
+ "name" : "xxx",
+ "domain" : {
+ "name" : "xxx",
+ "id" : "ded649d814464428ba89d04d7955c93e"
+ }
+ },
+ "response" : {
+ "code" : "VPC.0514",
+ "message" : "Update port fail."
+ },
+ "code" : 200,
+ "service_type" : "VPC",
+ "resource_type" : "eip",
+ "resource_name" : "192.144.163.1",
+ "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
+ "trace_name" : "deleteEip",
+ "trace_rating" : "warning",
+ "trace_type" : "ConsoleAction",
+ "api_version" : "2.0",
+ "record_time" : 1481066128032,
+ "trace_id" : "e001ccb9-bc09-11e6-b00b-4b2a61338db6"
+ }, {
+ "time" : 1472148708232,
+ "user" : {
+ "name" : "xxx",
+ "domain" : {
+ "name" : "xxx",
+ "id" : "ded649d814464428ba89d04d7955c93e"
+ }
+ },
+ "response" : {
+ "code" : "VPC.0514",
+ "message" : "Update port fail."
+ },
+ "code" : 200,
+ "service_type" : "VPC",
+ "resource_type" : "eip",
+ "resource_name" : "192.144.163.1",
+ "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
+ "trace_name" : "deleteEip",
+ "trace_rating" : "warning",
+ "trace_type" : "ConsoleAction",
+ "api_version" : "2.0",
+ "record_time" : 1481066128032,
+ "trace_id" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
+ } ]
+}
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+The request is successful.
+ |
+
+400
+ |
+The request is not completed due to abnormal query parameters.
+ |
+
+401
+ |
+The request is rejected due to authentication failure.
+ |
+
+403
+ |
+The server understood the request but refused to authorize it.
+ |
+
+404
+ |
+The requested traces do not exist.
+ |
+
+500
+ |
+Failed to complete the request because of an internal service error.
+ |
+
+503
+ |
+The requested service is invalid. The client should not repeat the request without modifications.
+ |
+
+
+
+
+
+
+ Modifying a Tracker
+FunctionThis API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, trace search and analysis using LTS, trace file integrity check, and tracker enablement or disablement. Modifying tracker parameters does not affect the existing operation records. After the modification is complete, the new rules are immediately applied to operation recording.
+
+ URIPUT /v1.0/{project_id}/tracker/{tracker_name}
+
+ Table 1 Path parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+project_id
+ |
+Yes
+ |
+String
+ |
+Project ID. For details about how to obtain a project ID, see Obtaining a Project ID.
+ |
+
+tracker_name
+ |
+Yes
+ |
+String
+ |
+Tracker name. Currently, only one tracker is allowed for each tenant. The tracker name is system.
+ |
+
+
+
+
+
+ Request Parameters
+ Table 2 Request body parametersParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+bucket_name
+ |
+No
+ |
+String
+ |
+OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
+ |
+
+file_prefix_name
+ |
+No
+ |
+String
+ |
+Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
+ |
+
+status
+ |
+No
+ |
+String
+ |
+Tracker status. The value can be enabled or disabled. If you change the value to disabled, the tracker stops recording traces.
+Value:
+
+ |
+
+is_obs_created
+ |
+No
+ |
+Boolean
+ |
+Whether an OBS bucket is created. If the value is true, an OBS bucket will be created to store trace files. If the value is false, trace files will be stored in an existing OBS bucket. A bucket name contains 3 to 64 characters, including digits, letters, and a hyphen (-) or a period (.).
+ |
+
+is_support_trace_files_encryption
+ |
+No
+ |
+Boolean
+ |
+Whether trace files are encrypted during transfer to an OBS bucket. This parameter must be used with kms_id.
+ |
+
+kms_id
+ |
+No
+ |
+String
+ |
+Key ID used for transferring and encrypting trace files. This key ID is obtained from Key Management Service (KMS). This parameter is mandatory when is_support_trace_files_encryption is set to true.
+ |
+
+lts
+ |
+No
+ |
+Lts object
+ |
+Trace analysis.
+ |
+
+log_file_validate
+ |
+No
+ |
+LogFileValidate object
+ |
+File verification.
+ |
+
+
+
+
+
+ Table 3 LtsParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+is_lts_enabled
+ |
+Yes
+ |
+Boolean
+ |
+Whether the LTS search function is enabled.
+ |
+
+log_group_name
+ |
+Yes
+ |
+String
+ |
+Name of the log group that CTS creates in LTS.
+ |
+
+log_topic_name
+ |
+Yes
+ |
+String
+ |
+Name of the log topic that CTS creates in LTS.
+ |
+
+
+
+
+
+ Table 4 LogFileValidateParameter
+ |
+Mandatory
+ |
+Type
+ |
+Description
+ |
+
|---|
+
+is_support_validate
+ |
+Yes
+ |
+Boolean
+ |
+Whether to enable trace file verification.
+ |
+
+
+
+
+
+ Response ParametersNone
+
+ Example RequestPUT https://{endpoint}/v1.0/{project_id}/tracker/system
+
+{
+ "bucket_name" : "my_created_bucket",
+ "file_prefix_name" : "some_folder",
+ "is_obs_created": true,
+ "is_support_trace_files_encryption": true,
+ "kms_id": "13a4207c-7abe-4b68-8510-16b84c3b5504",
+ "lts": {
+ "is_lts_enabled": true,
+ "log_group_name": "CTS",
+ "log_topic_name": 'system-trace'
+ },
+ "log_file_validate": {
+ "is_support_validate": true
+ },
+ "status" : "disabled"
+}
+
+
+ Status Codes
+ Status Code
+ |
+Description
+ |
+
|---|
+
+200
+ |
+The request 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.
+ |
+
+500
+ |
+The request failed to be executed or some trackers failed to be deleted.
+ |
+
+
+
+
+
+
+ Trace Management
-
-
-
diff --git a/docs/cts/api-ref/en-us_topic_0168602179.html b/docs/cts/api-ref/en-us_topic_0168602179.html
deleted file mode 100644
index f1f45766..00000000
--- a/docs/cts/api-ref/en-us_topic_0168602179.html
+++ /dev/null
@@ -1,8 +0,0 @@
-
-
-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.
- Deleting a Tracker
-FunctionThis 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.
-
- URIDELETE /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 URIParameter
- |
-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- Parameter description
None
-
-
-
- Response- Parameter description
None
-
-
-
- Returned Value- Normal
-
Table 2 Return code for successful requestsReturned Value
- |
-Description
- |
-
|---|
-
-204
- |
-The tracker is deleted successfully.
- |
-
-
-
- - Abnormal
-
Table 3 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400
- |
-The server failed to process the request.
- |
-
-404
- |
-The server failed to find the requested resource or deleting some trackers failed.
- |
-
-500
- |
-The request failed to be executed or some trackers failed to be deleted.
- |
-
-401
- |
-Your access request is rejected.
- |
-
-403
- |
-You are forbidden to access the requested page.
- |
-
-
-
-
-
- Querying Traces (v1.0)
-FunctionThis API is used to query records of operations on resources in the last seven days.
-
- URIGET /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 URIParameter
- |
-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- Parameter description
-
Table 2 Parameters in the requestParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-service_type
- |
-No
- |
-String
- |
-Type of a service whose traces are to be queried. The value must be the abbreviation of a cloud service that has been interconnected with CTS. It is a word composed of uppercase letters. For the interconnected cloud services, see section "Supported Services" in the Cloud Trace Service User Guide.
- |
-
-resource_type
- |
-No
- |
-String
- |
-Type of a resource whose traces are to be queried. The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), underscores (_), and periods (.). It must start with a letter. For the interconnected cloud services, see section "Supported Services" in the Cloud Trace Service User Guide.
- |
-
-resource_id
- |
-No
- |
-String
- |
-ID of a resource whose traces are to be queried
- |
-
-resource_name
- |
-No
- |
-String
- |
-Name of a resource whose traces are to be queried
- |
-
-trace_name
- |
-No
- |
-String
- |
-Trace name. It indicates the operation recorded by this trace. The value can contain 1 to 64 characters, including letters, numbers, hyphens (-), underscores (_), and periods (.). It must start with a letter.
- |
-
-limit
- |
-No
- |
-String
- |
-Number of traces returned in the trace list. The default value is 50 and the maximum value is 200.
- |
-
-next
- |
-No
- |
-String
- |
-This parameter is used to query traces generated earlier than its specified value. The value can be that of marker in Table 5.
-next can be used with the parameters from and to.
-Traces generated in the overlap of the two time ranges specified respectively by next and by from and to will be returned.
- |
-
-from
- |
-No
- |
-String
- |
-UTC timestamp of the start time of the query time range. The value is in milliseconds and contains 13 numbers. Traces generated on the specified timestamp are not returned. The parameters from and to should be used together.
- |
-
-to
- |
-No
- |
-String
- |
-UTC timestamp of the end time of the query time range. The value is in milliseconds and contains 13 numbers. Traces generated on the specified timestamp are not returned. The parameters to and from should be used together.
- |
-
-trace_id
- |
-No
- |
-String
- |
-ID of a trace.
-If this parameter is specified, other query criteria will not take effect.
- |
-
-trace_rating
- |
-No
- |
-String
- |
-Status of a trace. The value can be normal, warning, or incident.
- |
-
-user
- |
-No
- |
-String
- |
-Name of the user whose traces are to be queried
- NOTE: The username is case sensitive.
-
- |
-
-
-
-
-
-
- Response- Parameter description
-
Table 3 Parameters in the responseParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-traces
- |
-array
- |
-List of returned traces
- |
-
-meta_data
- |
-Structure
- |
-Extended parameter. The value can be count (number of traces in the response) or marker (ID of the last trace in the trace list).
- |
-
-
-
-
- Table 4 Data structure of the traces parameterParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-resource_id
- |
-String
- |
-ID of a resource on which an operation was performed
- |
-
-trace_name
- |
-String
- |
-Name of a trace. The value will contain 1 to 64 characters, including letters, numbers, hyphens (-), underscores (_), and periods (.). It will also start with a letter.
- |
-
-trace_rating
- |
-String
- |
-Status of a trace. The value can be normal, warning, or incident.
- |
-
-trace_type
- |
-String
- |
-Type of a source trace. The value can be ApiCall, ConsoleAction, or SystemAction.
- |
-
-request
- |
-String
- |
-Request of an operation on resources
- |
-
-response
- |
-String
- |
-Response to a user request, that is, the returned information for an operation on resources.
- |
-
-code
- |
-String
- |
-HTTP status code returned by the associated API
- |
-
-api_version
- |
-String
- |
-Version of the API
- |
-
-message
- |
-String
- |
-Remarks added by other cloud services to a trace
- |
-
-record_time
- |
-Long
- |
-Timestamp when an operation was recorded by CTS
- |
-
-trace_id
- |
-String
- |
-ID of a trace. The value is the UUID generated by the system.
- |
-
-time
- |
-Long
- |
-Timestamp when an operation occurred
- |
-
-user
- |
-String
- |
-Information of the user who performed the operation that triggered the trace.
- |
-
-service_type
- |
-String
- |
-Type of a service whose traces were queried. The value is the abbreviation of a cloud service that has been interconnected with CTS. It is a word composed of uppercase letters.
- |
-
-resource_type
- |
-String
- |
-Type of a resource whose traces were queried. The value will contain 1 to 64 characters, including letters, numbers, hyphens (-), underscores (_), and periods (.). It will also start with a letter.
- |
-
-source_ip
- |
-String
- |
-IP address of the user who performed the operation that triggered the trace.
- |
-
-resource_name
- |
-String
- |
-Name of a resource whose traces were queried
- |
-
-request_id
- |
-String
- |
-Request ID
- |
-
-location_info
- |
-String
- |
-Additional information required for fault locating after a request error
- |
-
-endpoint
- |
-String
- |
-Endpoint in the detail page URL of the cloud resource on which the recorded operation was performed
- |
-
-resource_url
- |
-String
- |
-Detail page URL (excluding the endpoint) of the cloud resource on which the recorded operation was performed
- |
-
-
-
-
-
- Table 5 Data structure of the meta_data parameterParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-count
- |
-Integer
- |
-Number of traces returned in the trace list
- |
-
-marker
- |
-String
- |
-ID of the last trace in the trace list. The value of this parameter can be used as the next value. If the value of marker is null, all traces have been returned.
- |
-
-
-
-
-
- - Example response
{
- "traces" : [ {
- "time" : 1472148708232,
- "user" : "{\"name\":\"xxx\",\"domain\":{\"name\":\"xxx\",\"id\":\"ded649d814464428ba89d04d7955c93e\"},\"assumedBy\":{\"user\":{\"name\":\"bss_bm_admin\",\"id\":\"c5140af45b5d4b399dea8f900f1dcf1b\",\"domain\":{\"name\":\"op_service\",\"id\":\"71ce673175024d0495664e525e52bac0\"}}}}",
- "response" : "{\"code\":\"VPC.0514\",\"message\":\"Update port fail.\"}",
- "code" : 200,
- "service_type" : "VPC",
- "resource_type" : "eip",
- "resource_name" : "192.144.163.1",
- "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
- "trace_name" : "deleteEip",
- "trace_rating" : "warning",
- "trace_type" : "ConsoleAction",
- "api_version" : "2.0",
- "record_time" : 1481066128032,
- "trace_id" : "e001ccb9-bc09-11e6-b00b-4b2a61338db6"
- "request_id" : "a0001c1b9-bctt-2136-c12b-4b2a611116"
- "location_info" : "resource has been deleted"
- "endpoint" : "https://*****/vpc?agencyId=***®ion=***&locale=zh-cn#"
- "resource_url" : "/vpc/vpcmanager/vpcs?vpcid=*****"
- }, {
- "time" : 1472148708232,
- "user" : "{\"name\":\"xxx\",\"domain\":{\"name\":\"xxx\",\"id\":\"ded649d814464428ba89d04d7955c93e\"},\"assumedBy\":{\"user\":{\"name\":\"bss_bm_admin\",\"id\":\"c5140af45b5d4b399dea8f900f1dcf1b\",\"domain\":{\"name\":\"op_service\",\"id\":\"71ce673175024d0495664e525e52bac0\"}}}}",
- "response" : "{\"code\":\"VPC.0514\",\"message\":\"Update port fail.\"}",
- "code" : 200,
- "service_type" : "VPC",
- "resource_type" : "eip",
- "resource_name" : "192.144.163.1",
- "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
- "trace_name" : "deleteEip",
- "trace_rating" : "warning",
- "trace_type" : "ConsoleAction",
- "api_version" : "2.0",
- "record_time" : 1481066128032,
- "trace_id" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
- "request_id" : "a0001c1b9-bctt-2136-c12b-4b2a611116"
- "location_info" : "resource has been deleted"
- "endpoint" : "https://*****/vpc?agencyId=***®ion=***&locale=zh-cn#"
- "resource_url" : "/vpc/vpcmanager/vpcs?vpcid=*****"
- } ],
- "meta_data" : {
- "count" : 2,
- "marker" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
- }
-}
-
-
- Returned Value- Normal
-
Table 6 Return code for successful requestsReturned Value
- |
-Description
- |
-
|---|
-
-200
- |
-The request is successful and the query result is returned.
- |
-
-
-
- - Abnormal
-
Table 7 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400
- |
-The query parameters are abnormal.
- |
-
-500
- |
-Failed to complete the request because of an internal service error.
- |
-
-401
- |
-Your access request is rejected.
- |
-
-403
- |
-You are forbidden to access the requested page.
- |
-
-404
- |
-The requested trace does not exist.
- |
-
-
-
-
-
- Modifying a Tracker
-FunctionCTS 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.
-
- URIPUT /v1.0/{project_id}/tracker/{tracker_name}
- The URI parameters are described in Table1 Parameters in the URI.
- Table 1 Parameters in the URIParameter
- |
-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- Parameter description
-
Table 2 Parameters in the requestParameter
- |
-Sub-Parameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-bucket_name
- |
-N/A
- |
-Yes
- |
-String
- |
-OBS bucket name. It starts with a number or lowercase letter and contains 3 to 63 characters, including lowercase letters, numbers, hyphens (-), and periods (.)
- |
-
-file_prefix_name
- |
-N/A
- |
-No
- |
-String
- |
-Prefix of trace files that need to be stored in OBS buckets. The value contains 0 to 64 characters, including letters, numbers, hyphens (-), underscores (_), and periods (.)
- |
-
-status
- |
-N/A
- |
-No
- |
-String
- |
-Status of a tracker. The value can be enabled or disabled. If you change the value to disabled, the tracker stops recording traces.
- |
-
-lts
- |
-is_lts_enabled
- |
-Yes
- |
-Boolean
- |
-Whether trace analysis is enabled.
- NOTE: When you enable trace analysis, a log group named CTS and a log stream named system-trace are created in LTS.
-
- |
-
-
-
-
- - Example request
PUT /v1.0/{project_id}/tracker/system
-{
- "bucket_name" : "my_created_bucket",
- "file_prefix_name" : "some_folder",
- "lts" : {
- "is_lts_enabled" : true,
- },
- "status" : "disabled"
-}
-
-
- Response- Parameter description
-
Table 3 Parameters in the responseParameter
- |
-Sub-Parameter
- |
-Type
- |
-Description
- |
-
|---|
-
-tracker_name
- |
-N/A
- |
-String
- |
-Tracker name. It is set as system by default.
- |
-
-bucket_name
- |
-N/A
- |
-String
- |
-OBS bucket name. It starts with a number or lowercase letter and contains 3 to 63 characters, including lowercase letters, numbers, hyphens (-), and periods (.)
- |
-
-file_prefix_name
- |
-N/A
- |
-String
- |
-Prefix of trace files that need to be stored in OBS buckets.
- |
-
-status
- |
-N/A
- |
-String
- |
-Status of a tracker. The value can be enabled or disabled.
- |
-
-lts
- |
-is_lts_enabled
- |
-Boolean
- |
-Whether trace analysis is enabled.
- |
-
-log_group_name
- |
-String
- |
-Name of the LTS log group.
- |
-
-log_topic_name
- |
-String
- |
-Name of the LTS log stream.
- |
-
-
-
-
-
-
- {
- "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- Normal
-
Table 4 Return code for successful requestsReturned Value
- |
-Description
- |
-
|---|
-
-200
- |
-The request is successfully processed.
- |
-
-
-
- - Abnormal
-
Table 5 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400
- |
-The server failed to process the request.
- |
-
-404
- |
-The server failed to find the requested resource.
- |
-
-500
- |
-Failed to complete the request because of an internal service error.
- |
-
-401
- |
-Your access request is rejected.
- |
-
-403
- |
-You are forbidden to access the requested page.
- |
-
-
-
-
-
- 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.
- |
-
-
-
-
- API Version Management
-
-
-
diff --git a/docs/cts/api-ref/en-us_topic_0168602232.html b/docs/cts/api-ref/en-us_topic_0168602232.html
deleted file mode 100644
index 66d195dc..00000000
--- a/docs/cts/api-ref/en-us_topic_0168602232.html
+++ /dev/null
@@ -1,21 +0,0 @@
-
-
-Tracker Management
-
-
-
diff --git a/docs/cts/api-ref/en-us_topic_0168602233.html b/docs/cts/api-ref/en-us_topic_0168602233.html
deleted file mode 100644
index ff745673..00000000
--- a/docs/cts/api-ref/en-us_topic_0168602233.html
+++ /dev/null
@@ -1,12 +0,0 @@
-
-
-Public Parameters
-
-
-
diff --git a/docs/cts/api-ref/en-us_topic_0168602243.html b/docs/cts/api-ref/en-us_topic_0168602243.html
deleted file mode 100644
index 7cfd36ef..00000000
--- a/docs/cts/api-ref/en-us_topic_0168602243.html
+++ /dev/null
@@ -1,206 +0,0 @@
-
-
-Querying a Specified API Version
-FunctionThis API is used to query a specified API version of CTS.
-
- URIGET/{api_version}
- The URI parameters are described in Table 1.
- Table 1 Parameters in the URIParameter
- |
-Mandatory
- |
-Description
- |
-
|---|
-
-api_version
- |
-Yes
- |
-API version
- |
-
-
-
-
-
-
-
- Response- Parameter description
-
Table 2 Parameters in the responseParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-version
- |
-Yes
- |
-Array
- |
-Information of the API version.
- |
-
-id
- |
-Yes
- |
-String
- |
-Version ID (version number), for example, v1.
- |
-
-links
- |
-Yes
- |
-String
- |
-API URL
- |
-
-href
- |
-Yes
- |
-String
- |
-Reference address of the current API version
- |
-
-rel
- |
-Yes
- |
-String
- |
-Relationship between the current API version and the referenced address
- |
-
-version
- |
-Yes
- |
-String
- |
-If microversions are supported by the APIs of the given version, the maximum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.
- |
-
-status
- |
-Yes
- |
-String
- |
-Version status. The value will be one of the following:
-CURRENT: The version is the primary version.
-SUPPORTED: The version is an old version, but it is still supported.
-DEPRECATED: The version is a deprecated version, which may be deleted later.
- |
-
-updated
- |
-Yes
- |
-String
- |
-Version release time, which is the Coordinated Universal time (UTC). For example, the release time of v1 is 2014-06-28T12:20:21Z.
- |
-
-min_version
- |
-No
- |
-String
- |
-If microversions are supported by the APIs of the given version, the minimum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.
- |
-
-
-
- - Example response
{
- "version":
- {
- "id": "v1.0",
- "links": [
- {
- "href": "https://x.x.x.x/v1.0/",
- "rel": "self"
- }
- ],
- "min_version": "",
- "status": "CURRENT",
- "updated": "2018-09-30T00:00:00Z",
- "version": ""
- }
- ]
-}
-
-
- Returned Value- Normal
200
- - Abnormal
-
Table 3 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400 Bad Request
- |
-Request error.
- |
-
-401 Unauthorized
- |
-The authentication information is not provided or is incorrect.
- |
-
-403 Forbidden
- |
-The request was forbidden.
- |
-
-404 Not Found
- |
-The server failed to find the requested resource.
- |
-
-408 Request Timeout
- |
-The request timed out.
- |
-
-429 Too Many Requests
- |
-The number of requests exceeded the upper limit.
- |
-
-500 Internal Server Error
- |
-Failed to complete the request because of an internal service error.
- |
-
-503 Service Unavailable
- |
-The service is currently unavailable.
- |
-
-
-
-
-
- Querying All API Versions
-FunctionThis API is used to query all API versions supported by Cloud Trace Service (CTS).
-
-
-
- Response- Parameter description
-
Table 1 Parameters in the responseParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-version
- |
-Yes
- |
-Array
- |
-List of all API versions
- |
-
-id
- |
-Yes
- |
-String
- |
-Version ID (version number), for example, v1.
- |
-
-links
- |
-Yes
- |
-String
- |
-API URL
- |
-
-href
- |
-Yes
- |
-String
- |
-Reference address of the current API version
- |
-
-rel
- |
-Yes
- |
-String
- |
-Relationship between the current API version and the referenced address
- |
-
-version
- |
-Yes
- |
-String
- |
-If microversions are supported by the APIs of the given version, the maximum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.
- |
-
-status
- |
-Yes
- |
-String
- |
-Version status. The value will be one of the following:
-CURRENT: The version is the primary version.
-SUPPORTED: The version is an old version, but it is still supported.
-DEPRECATED: The version is a deprecated version, which may be deleted later.
- |
-
-updated
- |
-Yes
- |
-String
- |
-Version release time, which is the Coordinated Universal time (UTC). For example, the release time of v1 is 2014-06-28T12:20:21Z.
- |
-
-min_version
- |
-No
- |
-String
- |
-If microversions are supported by the APIs of the given version, the minimum microversion supported will be displayed. If microversions are not supported, this parameter will be left blank.
- |
-
-
-
- - Example response
{
- "version": [
- {
- "id": "v1.0",
- "links": [
- {
- "href": "https://x.x.x.x/v1.0/",
- "rel": "self"
- }
- ],
- "min_version": "",
- "status": "CURRENT",
- "updated": "2018-09-30T00:00:00Z",
- "version": ""
- }
- {
- "id": "v2.0",
- "links": [
- {
- "href": "https://x.x.x.x/v2.0/",
- "rel": "self"
- }
- ],
- "min_version": "",
- "status": "SUPPORTED",
- "updated": "2018-09-30T00:00:00Z",
- "version": ""
- }
- ]
-}
-
-
- Returned Value- Normal
200
- - Abnormal
-
Table 2 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400 Bad Request
- |
-Request error.
- |
-
-401 Unauthorized
- |
-The authentication information is not provided or is incorrect.
- |
-
-403 Forbidden
- |
-The request was forbidden.
- |
-
-404 Not Found
- |
-The server failed to find the requested resource.
- |
-
-408 Request Timeout
- |
-The request timed out.
- |
-
-429 Too Many Requests
- |
-The number of requests exceeded the upper limit.
- |
-
-500 Internal Server Error
- |
-Failed to complete the request because of an internal service error.
- |
-
-503 Service Unavailable
- |
-The service is currently unavailable.
- |
-
-
-
-
-
- Creating a Tracker
-All API URLs described in this section are case-sensitive.
- FunctionThis 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.
-
- URIPOST /v1.0/{project_id}/tracker
- The URI parameters are described in Table1 Parameters in the URI.
- Table 1 Parameters in the URIParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-project_id
- |
-Yes
- |
-String
- |
-Project ID.
- |
-
-
-
-
-
-
- Request- Parameter description
-
Table 2 Parameters in the requestParameter
- |
-Sub-Parameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-bucket_name
- |
-N/A
- |
-Yes
- |
-String
- |
-OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
- |
-
-file_prefix_name
- |
-N/A
- |
-No
- |
-String
- |
-Prefix of trace files that need to be stored in OBS buckets. The value can contain 0 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.).
- |
-
-lts
- |
-is_lts_enabled
- |
-No
- |
-Boolean
- |
-Whether trace analysis is enabled.
- NOTE: When you enable trace analysis, a log group named CTS and a log stream named system-trace are created in LTS.
-
- |
-
-
-
-
-
-
- Response- Parameter description
-
Table 3 Parameters in the responseParameter
- |
-Sub-Parameter
- |
-Type
- |
-Description
- |
-
|---|
-
-bucket_name
- |
-N/A
- |
-String
- |
-OBS bucket name. The value contains 3 to 63 characters and must start with a digit or lowercase letter. Only lowercase letters, digits, hyphens (-), and periods (.) are allowed.
- |
-
-file_prefix_name
- |
-N/A
- |
-String
- |
-Prefix of trace files that need to be stored in OBS buckets.
- |
-
-status
- |
-N/A
- |
-String
- |
-Status of a tracker. The value is enabled.
- |
-
-tracker_name
- |
-N/A
- |
-String
- |
-Tracker name. The default value is system.
- |
-
-lts
-
-
- |
-is_lts_enabled
- |
-Boolean
- |
-Whether trace analysis is enabled.
- |
-
-log_group_name
- |
-String
- |
-Name of the Log Tank Service (LTS) log group.
- |
-
-log_topic_name
- |
-String
- |
-Name of the LTS log stream.
- |
-
-
-
-
- - Example response
{
- "bucket_name" : "obs-f1da",
- "file_prefix_name" : "yO8Q",
- "lts" : {
- "is_lts_enabled" : true,
- "log_group_name" : "CTS",
- "log_topic_name" : "system-trace"
- },
- "bucket_name" : "1214",
- "tracker_name" : "system",
- "file_prefix_name" : "",
- "status" : "enabled",
- "tracker_type" : "system"
-}
-
-
- Returned Value- Normal
-
Table 4 Return code for successful requestsReturned Value
- |
-Description
- |
-
|---|
-
-201
- |
-The request is successful.
- |
-
-
-
- - Abnormal
-
Table 5 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400
- |
-The server failed to process the request.
- |
-
-403
- |
-The server understood the request but refused to authorize it.
- |
-
-500
- |
-Failed to complete the request because of an internal service error.
- |
-
-401
- |
-The request is rejected due to authentication failure.
- |
-
-400
- |
-The requested OBS bucket does not exist.
- |
-
-
-
-
-
- Querying Traces (v2.0)
-FunctionThis 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.
-
- URIGET /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 URIParameter
- |
-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- Parameter description
-
Table 2 Parameters in the requestParameter
- |
-Mandatory
- |
-Type
- |
-Description
- |
-
|---|
-
-service_type
- |
-No
- |
-String
- |
-Type of a service whose traces are to be queried. 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
- |
-No
- |
-String
- |
-Type of a resource whose traces are to be queried. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). It must start with a letter. For cloud services that can be connected with CTS, see section "Supported Services and Operations" in the Cloud Trace Service User Guide.
- |
-
-resource_id
- |
-No
- |
-String
- |
-ID of a cloud resource whose traces are to be queried.
- |
-
-resource_name
- |
-No
- |
-String
- |
-Name of a resource whose traces are to be queried.
- NOTE: The resource name is case sensitive.
-
- |
-
-trace_name
- |
-No
- |
-String
- |
-Trace name. It indicates the operation recorded by this trace.
- NOTE: The trace name is case sensitive.
-
- |
-
-limit
- |
-No
- |
-String
- |
-Number of traces returned in the trace list. The default value is 50 and the maximum value is 200.
- |
-
-next
- |
-No
- |
-String
- |
-This parameter is used to query traces generated earlier than its specified value. The value can be that of marker in Table 5.
-next can be used with from and to.
-Traces generated in the overlap of the two time ranges specified respectively by next and by from and to will be returned.
- |
-
-from
- |
-No
- |
-String
- |
-UTC timestamp of the start time of the query time range. The value is in milliseconds and contains 13 digits. Traces generated on the specified timestamp are not returned. The parameters from and to should be used together.
- |
-
-to
- |
-No
- |
-String
- |
-UTC timestamp of the end time of the query time range. The value is in milliseconds and contains 13 digits. Traces generated on the specified timestamp are not returned. The parameters to and from should be used together.
- |
-
-trace_id
- |
-No
- |
-String
- |
-Trace ID.
-If this parameter is specified, other query criteria will not take effect.
- |
-
-trace_status
- |
-No
- |
-String
- |
-Status of a trace. The value can be normal, warning, or incident.
- |
-
-user
- |
-No
- |
-String
- |
-Name of the user whose traces are to be queried.
- NOTE: The username is case sensitive.
-
- |
-
-
-
-
-
-
- Response- Parameter description
-
Table 3 Parameters in the responseParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-traces
- |
-array
- |
-List of returned traces.
- |
-
-meta_data
- |
-Structure
- |
-Extended parameter. The value can be count (number of traces in the response) or marker (ID of the last trace in the trace list).
- |
-
-
-
-
- Table 4 Data structure of the traces parameterParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-resource_id
- |
-String
- |
-ID of a cloud resource on which the recorded operation was performed.
- |
-
-trace_name
- |
-String
- |
-Name of a trace. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). It must start with a letter.
- |
-
-trace_status
- |
-String
- |
-Trace status. The value can be normal, warning, or incident.
- |
-
-trace_type
- |
-String
- |
-Trace source. The value can be ApiCall, ConsoleAction, or SystemAction.
- |
-
-request
- |
-String
- |
-Request of an operation on resources.
- |
-
-response
- |
-String
- |
-Response to a user request, that is, the returned information for an operation on resources.
- |
-
-code
- |
-String
- |
-HTTP status code returned by the associated API.
- |
-
-api_version
- |
-String
- |
-Version of the API.
- |
-
-message
- |
-String
- |
-Remarks added by other cloud services to a trace.
- |
-
-record_time
- |
-Long
- |
-Timestamp when an operation was recorded by CTS.
- |
-
-trace_id
- |
-String
- |
-Trace ID. The value is the UUID generated by the system.
- |
-
-time
- |
-Long
- |
-Timestamp when a trace was generated.
- |
-
-user
- |
-Structure
- |
-Information of the user who performed the operation that triggered the trace.
- |
-
-service_type
- |
-String
- |
-Type of a service whose traces are to be queried. The value must be the acronym of a cloud service that has been connected with CTS. It is a word composed of uppercase letters.
- |
-
-resource_type
- |
-String
- |
-Type of a resource whose traces are to be queried. The value can contain 1 to 64 characters, including letters, digits, hyphens (-), underscores (_), and periods (.). It must start with a letter.
- |
-
-source_ip
- |
-String
- |
-IP address of the tenant who performed the operation that triggered the trace.
- |
-
-resource_name
- |
-String
- |
-Name of a resource on which the recorded operation was performed.
- |
-
-request_id
- |
-String
- |
-Request ID.
- |
-
-location_info
- |
-String
- |
-Additional information required for fault locating after a request error.
- |
-
-endpoint
- |
-String
- |
-Endpoint in the details page URL of the cloud resource on which the recorded operation was performed.
- |
-
-resource_url
- |
-String
- |
-Details page URL (excluding the endpoint) of the cloud resource on which the recorded operation was performed.
- |
-
-
-
-
-
- Table 5 Data structure of the meta_data parameterParameter
- |
-Type
- |
-Description
- |
-
|---|
-
-count
- |
-Integer
- |
-Number of returned traces.
- |
-
-marker
- |
-String
- |
-ID of the last trace in the returned trace list. The value of this parameter can be used as the next value. If the value of marker is null, all traces have been returned.
- |
-
-
-
-
-
- - Example response
{
- "traces" : [ {
- "time" : 1472148708232,
- "user" : "{\"name\":\"xxx\",\"id\":\"a2e899190fcd444084a68fc0ac2sc1e9\",\"domain\":{\"name\":\"xxx\",\"id\":\"05b2598d69bc4a209f9ac5eeeb1f91ad\"}}",
- "response" : "{\"code\":\"VPC.0514\",\"message\":\"Update port fail.\"}",
- "code" : 200,
- "service_type" : "VPC",
- "resource_type" : "eip",
- "resource_name" : "192.144.163.1",
- "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
- "trace_name" : "deleteEip",
- "trace_status " : "warning",
- "trace_type" : "ConsoleAction",
- "api_version" : "2.0",
- "record_time" : 1481066128032,
- "trace_id" : "e001ccb9-bc09-11e6-b00b-4b2a61338db6"
- "request_id" : "a0001c1b9-bctt-2136-c12b-4b2a611116"
- "location_info" : "resource has been deleted"
- "endpoint" : "https://*****/vpc?agencyId=***®ion=***&locale=zh-cn#"
- "resource_url" : "/vpc/vpcmanager/vpcs?vpcid=*****"
- }, {
- "time" : 1472148708232,
- "user" : "{\"name\":\"xxx\",\"domain\":{\"name\":\"xxx\",\"id\":\"ded649d814464428ba89d04d7955c93e\"},\"assumedBy\":{\"user\":{\"name\":\"bss_bm_admin\",\"id\":\"c5140af45b5d4b399dea8f900f1dcf1b\",\"domain\":{\"name\":\"op_service\",\"id\":\"71ce673175024d0495664e525e52bac0\"}}}}",
- "response" : "{\"code\":\"VPC.0514\",\"message\":\"Update port fail.\"}",
- "code" : 200,
- "service_type" : "VPC",
- "resource_type" : "eip",
- "resource_name" : "192.144.163.1",
- "resource_id" : "d502809d-0d1d-41ce-9690-784282142ccc",
- "trace_name" : "deleteEip",
- "trace_status" : "warning",
- "trace_type" : "ConsoleAction",
- "api_version" : "2.0",
- "record_time" : 1481066128032,
- "trace_id" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
- "request_id" : "a0001c1b9-bctt-2136-c12b-4b2a611116"
- "location_info" : "resource has been deleted"
- "endpoint" : "https://*****/vpc?agencyId=***®ion=***&locale=zh-cn#"
- "resource_url" : "/vpc/vpcmanager/vpcs?vpcid=*****"
-
- } ],
- "meta_data" : {
- "count" : 2,
- "marker" : "e001ccb8-bc09-11e6-b2cc-2640a43cc6e8"
- }
-}
-
-
-
- Returned Value- Normal
-
Table 6 Return code for successful requestsReturned Value
- |
-Description
- |
-
|---|
-
-200
- |
-The request is successful and the query result is returned.
- |
-
-
-
-
- - Abnormal
-
Table 7 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400
- |
-The query parameters are abnormal.
- |
-
-500
- |
-Failed to complete the request because of an internal service error.
- |
-
-401
- |
-The request is rejected due to authentication failure.
- |
-
-403
- |
-The server understood the request but refused to authorize it.
- |
-
-404
- |
-The requested trace does not exist.
- |
-
-
-
-
-
- Querying a Tracker
-FunctionThis 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.
-
- URIGET /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 URIParameter
- |
-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- Parameter description
None
-
-
-
- Response- Parameter description
-
Table 2 Parameter
- |
-Sub-Parameter
- |
-Type
- |
-Description
- |
-
|---|
-
-tracker_name
- |
--
- |
-String
- |
-Tracker name. It is set as system by default.
- |
-
-bucket_name
- |
--
- |
-String
- |
-OBS bucket name. It starts with a number or lowercase letter and contains 3 to 63 characters, including lowercase letters, numbers, hyphens (-), and periods (.)
- |
-
-file_prefix_name
- |
--
- |
-String
- |
-Prefix of trace files that need to be stored in OBS buckets
- |
-
-status
- |
--
- |
-String
- |
-Status of a tracker. The value can be enabled or disabled.
- |
-
-detail
- |
--
- |
-String
- |
-This parameter is returned only when the tracker status is abnormal. It specifies the cause of the exception. The value will be checkBucketExistFailed, which indicates the failure to check the bucket, or noBucket, which indicates that the bucket does not exist.
- |
-
-|
- lts
-
- |
-is_lts_enabled
- |
-Boolean
- |
-Whether trace analysis is enabled
- |
-
-log_group_name
- |
-String
- |
-Name of the LTS log group
- |
-
-log_topic_name
- |
-String
- |
-Name of the LTS log stream
- |
-
-
-
-
- - Example response
{
- "bucket_name" : "my_created_bucket",
- "tracker_name" : "system",
- "detail" : "noBucket",
- "file_prefix_name" : "some_folder",
- "status" : "disabled",
- "lts" : {
- "is_lts_enabled" : true,
- "log_group_name" : "CTS",
- "log_topic_name" : "tracker"
- },
- "bucket_name" : "1214",
- "tracker_name" : "system",
-
-}
-
-
- Returned Value- Normal
-
Table 3 Return code for successful requestsReturned Value
- |
-Description
- |
-
|---|
-
-200
- |
-The request is successful and the query result is returned.
- |
-
-
-
- - Abnormal
-
Table 4 Return code for failed requestsReturned Value
- |
-Description
- |
-
|---|
-
-400
- |
-The server failed to process the request.
- |
-
-500
- |
-Failed to complete the request because of an internal service error.
- |
-
-401
- |
-Your access request is rejected.
- |
-
-403
- |
-You are forbidden to access the requested page.
- |
-
-
-
-
-
- Error Codes
-IntroductionThis 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.
- |
-
-
-
-
-
- API Description
-
-
-
diff --git a/docs/cts/api-ref/public_sys-resources/imageclose.gif b/docs/cts/api-ref/public_sys-resources/imageclose.gif
new file mode 100644
index 00000000..3a3344af
Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/imageclose.gif differ
diff --git a/docs/cts/api-ref/public_sys-resources/imageclosehover.gif b/docs/cts/api-ref/public_sys-resources/imageclosehover.gif
new file mode 100644
index 00000000..8699d5e3
Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/imageclosehover.gif differ
diff --git a/docs/cts/api-ref/public_sys-resources/imagemax.gif b/docs/cts/api-ref/public_sys-resources/imagemax.gif
new file mode 100644
index 00000000..99c07dc2
Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/imagemax.gif differ
diff --git a/docs/cts/api-ref/public_sys-resources/imagemaxhover.gif b/docs/cts/api-ref/public_sys-resources/imagemaxhover.gif
new file mode 100644
index 00000000..d01d77d6
Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/imagemaxhover.gif differ
diff --git a/docs/cts/api-ref/public_sys-resources/macFFBgHack.png b/docs/cts/api-ref/public_sys-resources/macFFBgHack.png
new file mode 100644
index 00000000..ec811470
Binary files /dev/null and b/docs/cts/api-ref/public_sys-resources/macFFBgHack.png differ
diff --git a/docs/cts/api-ref/topic_300000003.html b/docs/cts/api-ref/topic_300000000.html
similarity index 85%
rename from docs/cts/api-ref/topic_300000003.html
rename to docs/cts/api-ref/topic_300000000.html
index b38a9fc0..ff19f8d3 100644
--- a/docs/cts/api-ref/topic_300000003.html
+++ b/docs/cts/api-ref/topic_300000000.html
@@ -1,4 +1,4 @@
-
+
Key Event Notification Management
@@ -15,7 +15,7 @@
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
|
|---|
