DescribeClusterOperateLogs - Data Transmission Service - Alibaba Cloud Documentation Center

Queries operation logs of a Data Transmission Service (DTS) dedicated cluster.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	DescribeClusterOperateLogs	The operation that you want to perform. Set the value to DescribeClusterOperateLogs.
StartTime	Long	No	1650866955000	The beginning of the time range to query. The value must be in the UNIX timestamp format. Unit: milliseconds. If you do not specify this parameter, the data within the last seven days is returned by default.
EndTime	Long	No	1650866995000	The end of the time range to query. The value must be in the UNIX timestamp format. Unit: milliseconds.
DedicatedClusterId	String	Yes	dtsxxxxx	The ID of the DTS dedicated cluster on which a DTS task runs.
PageSize	Integer	No	20	The number of entries to return on each page. Default value: 20.
PageNumber	Integer	No	1	The number of the page to return. The value of this parameter must be an integer that is greater than 0. Default value: 1.
DtsJobId	String	No	k2gm967v16f****	The ID of the data migration or data synchronization task.
ClientToken	String	No	0c593ea1-3bea-11e9-b96b-88e9fe63****	The client token that is used to ensure the idempotence of the request. You can use the client to generate a client token. Make sure that a unique client token is used for each request. The ClientToken value can contain only ASCII characters and cannot exceed 64 characters in length.
AccountId	String	No	12323344****	The ID of the Alibaba Cloud account.

Response parameters


Parameter	Type	Example	Description
DataPoints	Array of DataPoint		The information about the operation logs.
Id	String	237827	The primary key of the log table.
LogDatetime	Long	1642077211574	The time when the operation is recorded. The value is in the UNIX timestamp format. Unit: milliseconds.
OperationName	String	modify-oversold-ratio	The type of the operation.
OperationUser	String	null	The user who performed the operation.
OldValue	String	100	The value of the parameter before the operation if the operation is an UPDATE operation.
NewValue	String	105	The value of the parameter after the operation if the operation is an UPDATE operation.
Content	String	null	Other description of the operation.
Success	Integer	1	Indicates whether the request was successful. A value of 1 indicates that the request was successful.
PageNumber	Integer	1	The page number of the returned page.
PageRecordCount	Integer	20	The number of entries returned per page.
TotalRecordCount	Long	100	The total number of records.
Success	Boolean	true	Indicates whether the request was successful.
Code	String	500	The error code returned by the backend service. The number is incremented.
ErrCode	String	InternalError	The error code returned if the request failed.
ErrMessage	String	The Value of Input Parameter %s is not valid.	The error message returned.
DynamicMessage	String	Type	The dynamic part in the error message. This parameter is used to replace %s in the ErrMessage parameter.
HttpStatusCode	Integer	200	The HTTP status code returned for an exception.
RequestId	String	621BB4F8-3016-4FAA-8D5A-5D3163CC****	The request ID.

Examples

Sample requests

http(s)://dts.aliyuncs.com/?Action=DescribeClusterOperateLogs
&StartTime=1650866955000
&EndTime=1650866995000
&DedicatedClusterId=dtsxxxxx
&PageSize=20
&PageNumber=1
&DtsJobId=k2gm967v16f****
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe63****
&AccountId=12323344****
&Common request parameters

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeClusterOperateLogsResponse>
    <requestId>1651135450713-***</requestId>
    <success>true</success>
    <code/>
    <errCode/>
    <errMessage/>
    <dynamicMessage/>
    <httpStatusCode>200</httpStatusCode>
    <pageNumber>1</pageNumber>
    <pageRecordCount>3</pageRecordCount>
    <totalRecordCount>3</totalRecordCount>
    <dataPoints>
        <id>2</id>
        <logDatetime>1642077211574</logDatetime>
        <operationName>modify-network-***</operationName>
        <operationUser/>
        <oldValue>1</oldValue>
        <newValue>2</newValue>
        <content>ak</content>
        <success>1</success>
    </dataPoints>
    <dataPoints>
        <id>3</id>
        <logDatetime>1642077211574</logDatetime>
        <operationName>modify-network-***</operationName>
        <operationUser/>
        <oldValue>2</oldValue>
        <newValue>3</newValue>
        <content>ak</content>
        <success>1</success>
    </dataPoints>
    <dataPoints>
        <id>4</id>
        <logDatetime>1642077211574</logDatetime>
        <operationName>modify-network-***</operationName>
        <operationUser/>
        <oldValue>3</oldValue>
        <newValue>4</newValue>
        <content>ak</content>
        <success>1</success>
    </dataPoints>
</DescribeClusterOperateLogsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "requestId" : "1651135450713-***",
  "success" : true,
  "httpStatusCode" : 200,
  "pageNumber" : 1,
  "pageRecordCount" : 3,
  "totalRecordCount" : 3,
  "dataPoints" : [ {
    "id" : "2",
    "logDatetime" : 1642077211574,
    "operationName" : "modify-network-***",
    "oldValue" : "1",
    "newValue" : "2",
    "content" : "ak",
    "success" : 1
  }, {
    "id" : "3",
    "logDatetime" : 1642077211574,
    "operationName" : "modify-network-***",
    "oldValue" : "2",
    "newValue" : "3",
    "content" : "ak",
    "success" : 1
  }, {
    "id" : "4",
    "logDatetime" : 1642077211574,
    "operationName" : "modify-network-***",
    "oldValue" : "3",
    "newValue" : "4",
    "content" : "ak",
    "success" : 1
  } ]
}

Error codes


HTTP status code	Error code	Error message	Description
403	InvalidParameter	The Value of Input Parameter %s is not valid.	The specified value was invalid. Check whether the parameter is specified and whether the AccessKey pair is valid.
403	InvalidSecurityToken.Expired	Specified SecurityToken is expired.	The signature expired. Use a new signature.
400	Throttling.User	Request was denied due to user flow control.	The number of requests reached the limit and the request was rejected. Try again later.
500	ServiceUnavailable	The request has failed due to a temporary failure of the server.	The response of the server timed out or the server was unavailable. Try again. If the error persists, contact technical support.

For a list of error codes, see Service error codes.