Queries a list of baseline instances.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
Action | String | Yes | ListBaselineStatuses | The operation that you want to perform. Set the value to ListBaselineStatuses. |
PageNumber | Integer | Yes | 1 | The page number. Valid values: 1 to 30. Default value: 1. |
PageSize | Integer | Yes | 10 | The number of entries per page. Valid values: 1 to 100. Default value: 10. |
Bizdate | String | Yes | 2020-07-07T00:00:00+0800 | The data timestamp. Specify the time in the ISO 8601 standard in the yyyy-MM-dd'T'HH:mm:ssZ format. The time must be in UTC. |
Priority | String | No | 1,3,5,7,8 | The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. You can specify multiple priorities. Separate them with commas (,). |
SearchText | String | No | Keyword in baseline names | The keyword in baseline names, which is used to search for the baselines whose names contain the keyword. |
Owner | String | No | 9527952795**** | The ID of the Alibaba Cloud account used by the baseline owner. |
TopicId | Long | No | 1234 | The event ID. |
FinishStatus | String | No | FINISH,UNFINISH | The status of the baseline instance. Valid values: UNFINISH and FINISH. You can specify multiple statuses. Separate them with commas (,). |
Status | String | No | SAFE,DANGEROUS,OVER | The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time. You can specify multiple statuses. Separate them with commas (,). |
BaselineTypes | String | No | DAILY,HOURLY | The type of the baseline. Valid values: DAILY and HOURLY. You can specify multiple types. Separate them with commas (,). |
Response parameters
Parameter | Type | Example | Description |
HttpStatusCode | Integer | 200 | The HTTP status code. |
RequestId | String | 0000-ABCD-EFG**** | The request ID. |
ErrorMessage | String | The specified parameters are invalid. | The error message. |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists | The error code. |
Success | Boolean | true | Indicates whether the request was successful. |
Data | Object | The data returned. | |
PageNumber | Integer | 1 | The page number. |
PageSize | Integer | 10 | The number of entries per page. |
TotalCount | Integer | 100 | The total number of baseline instances returned. |
BaselineStatuses | Array of BaselineStatuses | The list of baseline instances. | |
Status | String | SAFE | The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time. |
Owner | String | 9527952795**** | The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,). |
FinishTime | Long | 1553531400000 | The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH. |
ProjectId | Long | 1234 | The ID of the workspace to which the baseline belongs. |
Priority | Integer | 1 | The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. |
EndCast | Long | 1553531400000 | The timestamp of the predicted time when the baseline instance finished running. |
InGroupId | Integer | 1 | The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: 1 to 24. The ID of a day-level cycle is 1. |
BaselineName | String | Baseline name | The name of the baseline. |
BaselineId | Long | 1234 | The baseline ID. |
FinishStatus | String | UNFINISH | The status of the baseline instance. Valid values: UNFINISH and FINISH. |
Bizdate | Long | 1553443200000 | The data timestamp. |
Buffer | Long | 1800 | The margin of the baseline instance. Unit: seconds. |
SlaTime | Long | 1553531400000 | The timestamp of the actual time when the baseline instance finished running. |
ExpTime | Long | 1553531400000 | The timestamp of the alerting time of the baseline instance. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=ListBaselineStatuses
&PageNumber=1
&PageSize=10
&Bizdate=2020-07-07T00:00:00+0800
&Priority=1,3,5,7,8
&SearchText=Keyword in baseline names
&Owner=9527952795****
&TopicId=1234
&FinishStatus=FINISH,UNFINISH
&Status=SAFE,DANGEROUS,OVER
&BaselineTypes=DAILY,HOURLY
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<ListBaselineStatusesResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<Success>true</Success>
<Data>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>100</TotalCount>
<BaselineStatuses>
<Status>SAFE</Status>
<Owner>9527952795****</Owner>
<FinishTime>1553531400000</FinishTime>
<ProjectId>1234</ProjectId>
<Priority>1</Priority>
<EndCast>1553531400000</EndCast>
<InGroupId>1</InGroupId>
<BaselineName>Baseline name</BaselineName>
<BaselineId>1234</BaselineId>
<FinishStatus>UNFINISH</FinishStatus>
<Bizdate>1553443200000</Bizdate>
<Buffer>1800</Buffer>
<SlaTime>1553531400000</SlaTime>
<ExpTime>1553531400000</ExpTime>
</BaselineStatuses>
</Data>
</ListBaselineStatusesResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"HttpStatusCode" : 200,
"RequestId" : "0000-ABCD-EFG****",
"ErrorMessage" : "The specified parameters are invalid.",
"ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
"Success" : true,
"Data" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 100,
"BaselineStatuses" : [ {
"Status" : "SAFE",
"Owner" : "9527952795****",
"FinishTime" : 1553531400000,
"ProjectId" : 1234,
"Priority" : 1,
"EndCast" : 1553531400000,
"InGroupId" : 1,
"BaselineName" : "Baseline name",
"BaselineId" : 1234,
"FinishStatus" : "UNFINISH",
"Bizdate" : 1553443200000,
"Buffer" : 1800,
"SlaTime" : 1553531400000,
"ExpTime" : 1553531400000
} ]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | No permissions. |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The number of requests for the resource has exceeded the upper limit. |
429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | The number of requests per day for the resource has exceeded the upper limit. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | The DataWorks system is busy. Try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | Excessive requests have been submitted within a short period of time. Try again later. |
500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | DataWorks API is unavailable in this region. Try another region. |
500 | InternalError.System | An internal system error occurred. Try again later. | An internal error occurred. Try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | An internal error occurred. Try again later. |
For a list of error codes, see Service error codes.