调用GetBaselineStatus获取基线实例的详情。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetBaselineStatus |
要执行的操作。 |
BaselineId | Long | 是 | 1234 |
基线的ID。 |
Bizdate | String | 是 | 2020-07-07T00:00:00+0800 |
业务日期,需要使用UTC格式(yyyy-MM-dd'T'HH:mm:ssZ)。 |
InGroupId | Integer | 是 | 1 |
基线实例的周期号。天基线为1,小时基线的取值范围为[1,24]。 |
RegionId | String | 是 | cn-shanghai |
可用区的唯一标识。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Struct |
基线实例的详情。 |
|
BaselineId | Long | 1234 |
基线的ID。 |
BaselineName | String | 基线名称 |
基线的名称。 |
Bizdate | Long | 1553443200000 |
业务日期时间戳。 |
BlockInstance | Struct |
关键实例信息。 |
|
EndCast | Long | 1553443200000 |
实例的预计完成时间戳。 |
FinishTime | Long | 1553443200000 |
实例的实际完成时间戳。 |
InstanceId | Long | 12345 |
实例的ID。 |
NodeId | Long | 1234 |
节点的ID。 |
NodeName | String | 节点名称 |
节点的名称。 |
Owner | String | 9527952795**** |
节点责任人的阿里云UID。 |
ProjectId | Long | 1234 |
节点所在工作空间的ID。 |
Status | String | SUCCESS |
实例的状态,包括NOT_RUN(未运行)、WAIT_TIME(等待时间)、WAIT_RESOURCE(等待资源)、RUNNING(运行中)、CHECKING(校检中)、CHECKING_CONDITION(条件检测中)、FAILURE(运行失败)和SUCCESS(运行成功)。 |
Buffer | Float | 1200 |
基线实例的余量,单位为秒。 |
EndCast | Long | 1553443200000 |
基线实例的预计产出时间戳。 |
ExpTime | Long | 1553443200000 |
基线实例的预警时间戳。 |
FinishStatus | String | UNFINISH |
基线实例是否完成,包括UNFINISH(未完成)和FINISH(已完成)。 |
FinishTime | Long | 1553443200000 |
当FinishStatus(基线实例完成状态)为FINISH(已完成)时,返回基线实例的完成时间戳。 |
InGroupId | Integer | 1 |
基线实例的周期号。天基线为1,小时基线的取值范围为[1,24]。 |
LastInstance | Struct |
最晚实例信息。 |
|
EndCast | Long | 1553443200000 |
实例的预计完成时间戳。 |
FinishTime | Long | 1553443200000 |
实例的实际完成时间戳。 |
InstanceId | Long | 12345 |
实例的ID。 |
NodeId | Long | 1234 |
节点的ID。 |
NodeName | String | 节点名称 |
节点的名称。 |
Owner | String | 9527952795**** |
节点责任人的阿里云UID。 |
ProjectId | Long | 1234 |
节点所在工作空间的ID。 |
Status | String | SUCCESS |
实例的状态,包括NOT_RUN(未运行)、WAIT_TIME(等待时间)、WAIT_RESOURCE(等待资源)、RUNNING(运行中)、CHECKING(校检中)、CHECKING_CONDITION(条件检测中)、FAILURE(运行失败)和SUCCESS(运行成功)。 |
Owner | String | 9527952795**** |
基线责任人的阿里云UID。多个责任人之间使用英文逗号(,)分隔。 |
Priority | Integer | 1 |
基线的优先级,取值范围为{1,2,5,7,8}。 |
ProjectId | Long | 1234 |
基线所在工作空间的ID。 |
SlaTime | Long | 1553443200000 |
基线实例的承诺时间戳。 |
Status | String | SAFE |
基线的状态,包括ERROR(异常)、SAFE(安全)、DANGROUS(预警)和OVER(破线)。 |
ErrorCode | String | 1031203110005 |
错误码。 |
ErrorMessage | String | The specified parameters are invalid. |
错误信息。 |
HttpStatusCode | Integer | 200 |
HTTP返回码。 |
RequestId | String | 0000-ABCD-EFG**** |
本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
Success | Boolean | true |
调用是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetBaselineStatus
&BaselineId=1234
&Bizdate=2020-07-07T00:00:00+0800
&InGroupId=1
&RegionId=cn-shanghai
&<公共请求参数>
正常返回示例
XML
格式
<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>节点名称</NodeName>
<ProjectId>1234</ProjectId>
<NodeId>1234</NodeId>
<EndCast>1553443200000</EndCast>
</BlockInstance>
<BaselineName>基线名称</BaselineName>
<SlaTime>1553443200000</SlaTime>
<EndCast>1553443200000</EndCast>
<LastInstance>
<Status>SUCCESS</Status>
<Owner>9527952795****</Owner>
<FinishTime>1553443200000</FinishTime>
<InstanceId>12345</InstanceId>
<NodeName>节点名称</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
格式
{
"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": "节点名称",
"ProjectId": 1234,
"NodeId": 1234,
"EndCast": 1553443200000
},
"BaselineName": "基线名称",
"SlaTime": 1553443200000,
"EndCast": 1553443200000,
"LastInstance": {
"Status": "SUCCESS",
"Owner": "9527952795****",
"FinishTime": 1553443200000,
"InstanceId": 12345,
"NodeName": "节点名称",
"ProjectId": 1234,
"NodeId": 1234,
"EndCast": 1553443200000
}
},
"ErrorCode": 1031203110005,
"ErrorMessage": "The specified parameters are invalid.",
"Success": true
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | Forbidden.Not.Server | The dataworksAPI service is not available in this area. Please try it in another area. | 该地域还未开放DataWorks的API服务,请尝试其它地域。 |
500 | InternalError.System | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | 系统内部错误,请稍后再试。 |
500 | InternalError.Wkbench.ServiceError | An internal error occurred. | 服务开小差了。 |
500 | Invalid.Wkbench.Parameter | The specified parameters are invalid. | 参数错误。 |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | 对该资源的请求已超过您的可用上限。 |
429 | Throttling.Api.Risk | The request for this resource has exceeded your daily available limit. | 对该资源的请求已超过您的每日可用上限。 |
429 | Throttling.Resource | You have reached the limit for the resource. Please contact us by submitting a ticket. | 该资源已经达到您的使用上限,请提交工单进行咨询。 |
429 | Throttling.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 您被限制访问,请开通DataWorks企业版或旗舰版。 |
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交