Queries the logs of a real-time data ingestion job for an AnalyticDB for MySQL cluster.
Operation description
- General endpoint:
adb.aliyuncs.com. - Regional public endpoint:
adb.<region-id>.aliyuncs.com. Example:adb.cn-hangzhou.aliyuncs.com. - Regional Virtual Private Cloud (VPC) endpoint:
adb-vpc.<region-id>.aliyuncs.com. Example:adb-vpc.cn-hangzhou.aliyuncs.com.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| adb:DescribeApsActionLogs | none | *DBClusterLakeVersion acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| DBClusterId | string | Yes | The ID of the AnalyticDB for MySQL Data Lakehouse Edition cluster. Note
You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL clusters within a region.
| amv-bp1r053byu48p**** |
| RegionId | string | Yes | The region ID of the cluster. Note
You can call the DescribeRegions operation to query the most recent region list.
| cn-hangzhou |
| StartTime | string | Yes | The start time of the logs to be queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. | 2023-02-11T08:30:00Z |
| EndTime | string | Yes | The end time of the logs to be queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC. Note
The end time must be later than the start time. The maximum time range that can be specified is 30 days.
| 2023-02-11T09:30:00Z |
| WorkloadId | string | Yes | The ID of the real-time data ingestion job. | aps-hz109vpvt4fg8528d**** |
| Keyword | string | No | The keyword that you want to use for fuzzy match in the query. | table_test |
| Stage | string | No | The phase during which the logs to be queried were generated. Valid values:
Note
If you do not specify this parameter, logs of all the phases are queried.
| FullDataSync |
| State | string | No | The types of the logs. Separate multiple log types with commas (,). Valid values:
Note
If you do not specify this parameter, logs of all types are queried.
| INFO,WARN,ERROR |
| PageSize | integer | No | The number of entries per page. Valid values:
| 30 |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "A5EDBA27-AF3E-5966-9503-FD1557E19167",
"DBClusterId": "amv-bp1r053byu48p****",
"WorkloadId": "aps-hz109vpvt4fg8528d****",
"TotalCount": "3",
"PageSize": "30",
"PageNumber": "1",
"ActionLogs": [
{
"Time": "2023-02-01T05:46:30Z",
"Stage": "FullDataSync",
"State": "INFO,WARN,ERROR",
"Context": "DDL migration job finished"
}
],
"AccessDeniedDetail": "{\n \"AuthAction\": \"xxx\",\n \"AuthPrincipalDisplayName\": \"sampleName\",\n \"AuthPrincipalOwnerId\": \"111111111111111111\",\n \"AuthPrincipalType\": \"SubUser\",\n \"AuthResource\": \"xxx\",\n \"NoPermissionType\": \"xxx\",\n \"PolicyType\": \"xxx\"\n}"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 404 | InvalidDBCluster.NotFound | The DBClusterId provided does not exist in our records. | The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-05-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-01-24 | The Error code has changed | View Change Details |
| 2023-06-21 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-03-30 | The Error code has changed | View Change Details |