Queries baseline instances.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | ListBaselineStatuses | The operation that you want to perform. |
| Bizdate | String | Yes | 2020-07-07T00:00:00+0800 | Business date in the UTC format (yyyy-MM-dd'T'HH:mm:ssZ). |
| PageNumber | Integer | Yes | 1 | The number of pages that are returned. The default value is 1, the minimum value is 1, and the maximum value is 30. |
| PageSize | Integer | Yes | 10 | The number of entries to return on each page. Default value: 10. Maximum value: 100. |
| RegionId | String | Yes | cn-shanghai | The unique identifier of the zone. |
| Priority | String | No | 1,3,5,7,8 | The priority of the baseline. Valid values: 1,3,5,7, and 8. Multiple priorities are separated by commas (,). |
| SearchText | String | No | The keyword for searching the baseline name. | The keyword used to search for the baseline name. |
| Owner | String | No | 9527952795**** | The Alibaba Cloud UID of the owner of the baseline. |
| TopicId | Long | No | 1234 | The ID of the event. |
| FinishStatus | String | No | FINISH,UNFINISH | Indicates whether the baseline instance is complete. Valid values: UNFINISH and FINISH. Separate multiple states by using commas (,). |
| Status | String | No | SAFE,DANGROUS,OVER | The status of the baseline. Valid values: ERROR, SAFE, dangerous, and OVER. Separate multiple states by using commas (,). |
| BaselineTypes | String | No | DAILY,HOURLY | The type of the baseline. Valid values: DAILY and HOURLY. Separate multiple types with commas (,). |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| Data | Struct | The returned list of baseline instances. | |
| BaselineStatuses | Array of BaselineStatuses | The list of baseline instances. | |
| BaselineId | Long | 1234 | The ID of the baseline. |
| BaselineName | String | Baseline check | The name of the baseline. |
| Bizdate | Long | 1553443200000 | The timestamp of the business date. |
| Buffer | Long | 1800 | The buffer size of the baseline instance. Unit: seconds. |
| EndCast | Long | 1553531400000 | The expected completion time of the baseline instance. |
| ExpTime | Long | 1553531400000 | The alert time of the baseline instance. Valid values: |
| FinishStatus | String | UNFINISH | Indicates whether the baseline instance is complete. Valid values: UNFINISH and FINISH. |
| FinishTime | Long | 1553531400000 | If the baseline instance completion status is FINISH, the timestamp at which the baseline instance is completed is returned. |
| InGroupId | Integer | 1 | The cycle number of the baseline instance. The Tianji line is 1. The value range of the hour baseline is [1,24]. |
| Owner | String | 9527952795**** | The Alibaba Cloud UID of the owner of the baseline. Separate multiple responsible persons with commas (,). |
| Priority | Integer | 1 | The priority of the baseline. Valid values: 1,2,5,7, and 8. |
| ProjectId | Long | 1234 | The ID of the workspace to which the baseline belongs. |
| SlaTime | Long | 1553531400000 | The actual time when the baseline instance was completed. |
| Status | String | SAFE | The status of the baseline. Valid values: ERROR, SAFE, dangerous, and OVER. |
| PageNumber | Integer | 1 | The current page number. |
| PageSize | Integer | 10 | The size of each page. |
| TotalCount | Integer | 100 | The total number of baseline instances. |
| ErrorCode | String | Invalid.Tenant.ConnectionNotExists | The error code. |
| ErrorMessage | String | The specified parameters are invalid. | The error message. |
| HttpStatusCode | Integer | 200 | The HTTP status code. |
| RequestId | String | 0000-ABCD-EFG**** | The unique ID of the call. You can use the error ID to troubleshoot the error. |
| Success | Boolean | true | Indicates whether the request was successful. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=ListBaselineStatuses &Bizdate=2020-07-07T00:00:00+0800 &PageNumber=1 &PageSize=10 &RegionId=cn-shanghai &<common request parameters>
Sample success responses
XML format
<RequestId> 0000-ABCD-EFG**** </RequestId> <HttpStatusCode> 200 </HttpStatusCode> <Data> <TotalCount> 100 </TotalCount> <PageSize> 10 </PageSize> <PageNumber> 1 </PageNumber> <BaselineStatuses> <BaselineId> 1234 </BaselineId> <Buffer> 1800 </Buffer> <Status> SAFE </Status> <Owner> 9527952795**** </Owner> <Priority> 1 </Priority> <FinishStatus> UNFINISH </FinishStatus> <ProjectId> 1234 </ProjectId> <Bizdate> 1553443200000 </Bizdate> <ExpTime> 1553531400000 </ExpTime> <InGroupId> 1 </InGroupId> <FinishTime> 1553531400000 </FinishTime> <BaselineName> enter The </BaselineName> <SlaTime> 1553531400000 </SlaTime> <EndCast> 1553531400000 </EndCast> </BaselineStatuses> </Data> <ErrorCode> 1031203110005 </ErrorCode> <ErrorMessage> The specified parameters are invalid. </ErrorMessage> <Success>true</Success>
JSON Format
{"RequestId": "0000-ABCD-EFG****", "HttpStatusCode": 200, "Data": { "TotalCount": 100, "PageSize": 10, "PageNumber": 1, "BaselineStatuses": { "BaselineId": 1234, "Buffer": 1800, "Status": "SAFE", "Owner": "9527952795****", "Priority": 1, "FinishStatus": "UNFINISH", "ProjectId": 1234, "Bizdate": 15543443200000, "ExpTime": // "InGroupId": 1, "FinishTime": "baseline name", "SlaTime": 1535351400000,endcast ": 1553531400000},}" ErrorCode ": " Invalid.Tenant.ConnectionNotExists ", " ErrorMessage ": "The specified parameters are invalid.", "Success": true}
Error codes
| HttpCode | Error codes | Error message | Description |
|---|---|---|---|
| 500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | DataWorks API service is not available in this region. Please try another region. |
| 500 | InternalError.System | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
| 500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal system error occurred. Please try again later. |
| 500 | InternalError.Wkbench.ServiceError | An internal error occurred. | The service was open. |
| 500 | Invalid.Wkbench.Parameter | The specified parameters are invalid. | One or more parameters are invalid. |
| 429 | Throttling.Api | The request for this resource has exceeded your available limit. | The request for the resource exceeds your available upper limit. |
| 429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | The request for the resource has exceeded your daily availability limit. |
| 429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks the system is busy, please try again later. |
| 429 | Throttling.User | Your request is too frequent. Try again later. | Your request is too frequent, please try to slow down the request speed. |
| 403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | You have restricted access. Please activate DataWorks Enterprise Edition or above. |
Go to the Error Center For more information, see error codes.