Call GetBaselineStatus get embedded in the baseline instance.

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 Required GetBaselineStatus

The operation that you want to perform.

BaselineId Long Yes 1234

The ID of the baseline.

Bizdate String Required 2020-07-07T00:00:00+0800

Business date in the UTC format (yyyy-MM-dd'T'HH:mm:ssZ).

InGroupId Integer Yes 1

The cycle number of the baseline instance. The Tianji line is 1. The value range of the hour baseline is [1,24].

RegionId String Required cn-shanghai

The unique identifier of the zone.

Response parameters

Parameter Type Example Description
Data Struct

The details of the baseline instance.

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.

BlockInstance Struct

The information about key instances.

EndCast Long 1553443200000

The estimated completion timestamp of the instance.

FinishTime Long 1553443200000

The actual completion timestamp of the instance.

InstanceId Long 12345

The ID of the instance.

NodeId Long 1234

The ID of the node.

NodeName String The name of the node

The name of the node.

Owner String 9527952795****

The UID of the node owner.

ProjectId Long 1234

The ID of the workspace to which the node belongs.

Status String SUCCESS

The status of an instance, including NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS.

Buffer Float 1200

The buffer size of the baseline instance. Unit: seconds.

EndCast Long 1553443200000

The time when the baseline instance was generated.

ExpTime Long 1553443200000

The alert timestamp of the baseline instance.

FinishStatus String UNFINISH

Indicates whether the baseline instance is complete. Valid values: UNFINISH and FINISH.

FinishTime Long 1553443200000

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].

LastInstance Struct

The information of the latest instance.

EndCast Long 1553443200000

The estimated completion timestamp of the instance.

FinishTime Long 1553443200000

The actual completion timestamp of the instance.

InstanceId Long 12345

The ID of the instance.

NodeId Long 1234

The ID of the node.

NodeName String The name of the node

The name of the node.

Owner String 9527952795****

The UID of the node owner.

ProjectId Long 1234

The ID of the workspace to which the node belongs.

Status String SUCCESS

The status of an instance, including NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS.

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 1553443200000

The committed time of the baseline instance.

Status String SAFE

The status of the baseline. Valid values: ERROR, SAFE, dangrouus, and OVER.

ErrorCode String 1031203110005

The error code.

ErrorMessage String The specified parameters are invalid.

The returned 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 call is successful.

Examples

Sample requests

http(s)://[Endpoint]/? Action=GetBaselineStatus
&BaselineId=1234
&Bizdate=2020-07-07T00:00:00+0800
&InGroupId=1
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <BaselineId>1234</BaselineId>
    <Buffer>1200</Buffer>
    <Status>SAFE</Status>
    <Owner>9527952795****</Owner>
    <Priority>1</Priority>
    <FinishStatus>UNFINISH</FinishStatus>
    <ProjectId>9527</ProjectId>
    <Bizdate>1553443200000</Bizdate>
    <ExpTime>1553443200000</ExpTime>
    <InGroupId>1</InGroupId>
    <FinishTime>1553443200000</FinishTime>
    <BlockInstance>
        <Status>SUCCESS</Status>
        <Owner>9527952795****</Owner>
        <FinishTime>1553443200000</FinishTime>
        <InstanceId>12345</InstanceId>
        <NodeName> node name </NodeName>
        <ProjectId>1234</ProjectId>
        <NodeId>1234</NodeId>
        <EndCast>1553443200000</EndCast>
    </BlockInstance>
    <BaselineName> baseline name </BaselineName>
    <SlaTime>1553443200000</SlaTime>
    <EndCast>1553443200000</EndCast>
    <LastInstance>
        <Status>SUCCESS</Status>
        <Owner>9527952795****</Owner>
        <FinishTime>1553443200000</FinishTime>
        <InstanceId>12345</InstanceId>
        <NodeName> node name </NodeName>
        <ProjectId>1234</ProjectId>
        <NodeId>1234</NodeId>
        <EndCast>1553443200000</EndCast>
    </LastInstance>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid. </ErrorMessage>
<Success>true</Success>

JSON format

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "BaselineId": 1234,
        "Buffer": 1200,
        "Status": "SAFE",
        "Owner": "9527952795****",
        "Priority": 1,
        "FinishStatus": "UNFINISH",
        "ProjectId": 9527,
        "Bizdate": 1553443200000,
        "ExpTime": 1553443200000,
        "InGroupId": 1,
        "FinishTime": 1553443200000,
        "BlockInstance": {
            "Status": "SUCCESS",
            "Owner": "9527952795****",
            "FinishTime": 1553443200000,
            "InstanceId": 12345,
            "NodeName": "node name",
            "ProjectId": 1234,
            "NodeId": 1234,
            "EndCast": 1553443200000
        },
        "BaselineName": "baseline name",
        "SlaTime": 1553443200000,
        "EndCast": 1553443200000,
        "LastInstance": {
            "Status": "SUCCESS",
            "Owner": "9527952795****",
            "FinishTime": 1553443200000,
            "InstanceId": 12345,
            "NodeName": "node name",
            "ProjectId": 1234,
            "NodeId": 1234,
            "EndCast": 1553443200000
        }
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

Error code

HttpCode Error code Error message Description
403 Forbidden.Access Access is forbidden. Activate DataWorks first. Your access is restricted, possibly because you have not activated DataWorks.
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. The parameters are invalid.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. You cannot access resources without authorization.
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.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The number of resources has reached the upper limit. Submit a ticket.
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.

For a list of error codes, visit the API Error Center.