All Products
Search
Document Center

Microservices Engine:ListZkTrack

Last Updated:Nov 20, 2024

Obtains the track data of a ZooKeeper instance.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
mse:ListZkTracklist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RequestParsstringNo

The request parameters.

{}
InstanceIdstringYes

The ID of the instance.

mse-cn-0ju2yq****
PathstringNo

The path.

/path
SessionIdstringNo

The session ID.

0x301fdfbdbf00***
StartTslongYes

The start timestamp. Unit: seconds.

1669618483
EndTslongYes

The end timestamp. Unit: seconds.

1669619383
PageSizelongYes

The number of entries to return on each page.

20
PageNumlongYes

The number of the page to return.

1
ReversebooleanNo

Specifies whether to enable reverse ordering.

false
AcceptLanguagestringNo

The language of the response. Valid values:

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

HttpCodestring

The HTTP status code.

200
Tracesarray<object>

The track data.

Traceobject

The details of the data.

LogDatestring

The logging time.

2022-11-28 15:09:15,606
Timestampstring

The timestamp. It is not available.

1669619383000
SessionIdstring

The session ID.

0x301fdfbdbf00***
Pathstring

The path.

/path
TraceTypestring

The type of the trajectory. Valid values:

  • Push
  • Pull
  • Notify
Push
OpTypestring

The type of the operation. For trajectory of the Push type:

  • Create
  • Update
  • Delete
  • SetAcl
  • Multi

For trajectory of the Pull type:

  • GetData
  • GetChild
  • GetStat
Create
EventTypestring

The type of the event. For trajectory of the Notify type:

  • NodeCreated
  • NodeDeleted
  • NodeDataChanged
  • NodeChildrenChanged
NodeCreated
DataTypestring

The data type. Valid values:

  • persist
  • ephemeral
persist
Watchboolean

Indicates whether the monitoring feature is enabled.

true
Aclstring

The access control list (ACL).

world:anyone:cdrwa
MultiSizelong

The transaction size.

3
Resultstring

The returned result.

success
Ttllong

The time to live (TTL).

0
Finishedboolean

Indicates whether the transaction ended.

true
PageSizelong

The number of entries returned per page.

20
PageNumberlong

The page number of the returned page.

1
TotalCountlong

The total number of entries returned.

20
RequestIdstring

The ID of the request.

DC34E4A3-5F1C-4E40-86EA-02EDF967****
Messagestring

The message returned.

ok
ErrorCodestring

The error code returned if the request failed.

mse-100-000
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "HttpCode": "200",
  "Traces": [
    {
      "LogDate": "2022-11-28 15:09:15,606",
      "Timestamp": "1669619383000",
      "SessionId": "0x301fdfbdbf00***",
      "Path": "/path",
      "TraceType": "Push",
      "OpType": "Create",
      "EventType": "NodeCreated",
      "DataType": "persist",
      "Watch": true,
      "Acl": "world:anyone:cdrwa",
      "MultiSize": 3,
      "Result": "success",
      "Ttl": 0,
      "Finished": true
    }
  ],
  "PageSize": 20,
  "PageNumber": 1,
  "TotalCount": 20,
  "RequestId": "DC34E4A3-5F1C-4E40-86EA-02EDF967****\n",
  "Message": "ok",
  "ErrorCode": "mse-100-000",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalRequestInvalid request:%sInvalid request: %s
400InvalidParameterParameter error:%sRequest parameter error: %s
403NoPermissionYou are not authorized to perform this operation:%sYou do not have the permission to use this interface:%s
404NotFoundNot found:%sThe resource does not exist:%s
500InternalErrorConsole error. Try again later:%sConsole error. Try again later: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-06-14The Error code has changedView Change Details