GetBaselineStatus - - Alibaba Cloud ドキュメントセンター

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	GetBaselineStatus	The operation that you want to perform. Set the value to GetBaselineStatus.
BaselineId	Long	Yes	1234	The ID of the baseline.
Bizdate	String	Yes	2020-07-07T00:00:00+0800	The data timestamp of the baseline instance. Specify the time in the yyyy-MM-dd'T'HH:mm:ssZ format. The time must be in UTC.
InGroupId	Integer	Yes	1	The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.

Response parameters


Parameter	Type	Example	Description
HttpStatusCode	Integer	200	The HTTP status code returned.
RequestId	String	0000-ABCD-EFG****	The ID of the request. You can use the ID to troubleshoot issues.
ErrorMessage	String	The specified parameters are invalid.	The error message returned.
ErrorCode	String	1031203110005	The error code returned.
Success	Boolean	true	Indicates whether the request was successful.
Data	Object		The details of the baseline instance.
Status	String	SAFE	The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, 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 DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.
Owner	String	9527952795****	The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).
FinishTime	Long	1553443200000	The timestamp of the actual time when the baseline instance stopped 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, 2, 5, 7, and 8.
EndCast	Long	1553443200000	The timestamp of the predicted time when the baseline instance stopped running.
InGroupId	Integer	1	The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.
BaselineName	String	Baseline name	The name of the baseline.
BaselineId	Long	1234	The ID of the baseline.
FinishStatus	String	UNFINISH	The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance is run.
Bizdate	Long	1553443200000	The data timestamp of the baseline instance.
Buffer	Float	1200	The margin of the baseline instance. Unit: seconds.
SlaTime	Long	1553443200000	The timestamp of the committed time of the baseline instance.
ExpTime	Long	1553443200000	The timestamp of the alert time of the baseline instance.
LastInstance	Object		The latest information of the baseline instance.
Status	String	SUCCESS	The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the node. The value CHECKING_CONDITION indicates that branch conditions are being checked for the node. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.
Owner	String	9527952795****	The ID of the Alibaba Cloud account used by the owner of the node.
FinishTime	Long	1553443200000	The timestamp of the actual time when the baseline instance stopped running.
NodeName	String	Node name	The name of the node.
ProjectId	Long	1234	The ID of the workspace to which the node belongs.
InstanceId	Long	12345	The ID of the instance.
EndCast	Long	1553443200000	The timestamp of the predicted time when the baseline instance stopped running.
NodeId	Long	1234	The ID of the node.
BlockInstance	Object		The information about the key instance.
Status	String	SUCCESS	The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the node. The value CHECKING_CONDITION indicates that branch conditions are being checked for the node. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.
Owner	String	9527952795****	The ID of the Alibaba Cloud account used by the owner of the node.
FinishTime	Long	1553443200000	The timestamp of the actual time when the baseline instance stopped running.
NodeName	String	Node name	The name of the node.
ProjectId	Long	1234	The ID of the workspace to which the node belongs.
InstanceId	Long	12345	The ID of the instance.
EndCast	Long	1553443200000	The timestamp of the predicted time when the baseline instance stopped running.
NodeId	Long	1234	The ID of the node.

Examples

Sample requests

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

Sample success responses

XML format

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

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

JSON format

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

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

Error codes


HTTP status code	Error code	Error message	Description
429	Throttling.Api	The request for this resource has exceeded your available limit.	The error message returned because 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 error message returned because 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 error message returned because the DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.	The error message returned because 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.	The error message returned because the DataWorks API is unavailable in this region. Try another region.
500	InternalError.System	An internal system error occurred. Try again later.	The error message returned because an internal error has occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.	The error message returned because an internal error has occurred. Try again later.

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