调用ListBaselineStatuses接口,获取基线实例列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 |
类型 |
是否必选 |
示例值 |
描述 |
Action | String | 是 | ListBaselineStatuses | 系统规定参数。取值:ListBaselineStatuses。 |
PageNumber | Integer | 是 | 1 | 分页的页数。默认值为1,最小值为1,最大值为30。 |
PageSize | Integer | 是 | 10 | 每页显示的条数,默认值为10,最大值为100。 |
Bizdate | String | 是 | 2020-07-07T00:00:00+0800 | 业务日期,需要使用UTC格式(yyyy-MM-dd'T'HH:mm:ssZ)。 |
Priority | String | 否 | 1,3,5,7,8 | 基线的优先级,取值范围为{1,3,5,7,8}。多个优先级之间使用英文逗号(,)分隔。 |
SearchText | String | 否 | 基线名称搜索关键字 | 基线名称搜索关键字。 |
Owner | String | 否 | 9527952795**** | 基线责任人的阿里云UID。 |
TopicId | Long | 否 | 1234 | 相关事件的ID。 |
FinishStatus | String | 否 | FINISH,UNFINISH | 基线实例是否完成,包括UNFINISH(未完成)、FINISH(已完成)。多个状态之间使用英文逗号(,)分隔。 |
Status | String | 否 | SAFE,DANGROUS,OVER | 基线的状态,包括ERROR(异常)、SAFE(安全)、DANGROUS(预警)和OVER(破线)。多个状态之间使用英文逗号(,)分隔。 |
BaselineTypes | String | 否 | DAILY,HOURLY | 基线的类型,包括DAILY(天基线)和HOURLY(小时基线)。多个类型之间使用英文逗号(,)分隔。 |
返回数据
名称 |
类型 |
示例值 |
描述 |
HttpStatusCode | Integer | 200 | HTTP返回码。 |
RequestId | String | 0000-ABCD-EFG**** | 本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
ErrorMessage | String | The specified parameters are invalid. | 错误信息。 |
ErrorCode | String | Invalid.Tenant.ConnectionNotExists | 错误码。 |
Success | Boolean | true | 调用是否成功。 |
Data | Object | 返回的基线实例列表。 |
|
PageNumber | Integer | 1 | 当前的页数。 |
PageSize | Integer | 10 | 每页的大小。 |
TotalCount | Integer | 100 | 基线实例的总数。 |
BaselineStatuses | Array of BaselineStatuses | 基线实例列表。 |
|
Status | String | SAFE | 基线的状态,包括ERROR(异常)、SAFE(安全)、DANGROUS(预警)和OVER(破线)。 |
Owner | String | 9527952795**** | 基线责任人的阿里云UID。多个责任人之间使用英文逗号(,)分隔。 |
FinishTime | Long | 1553531400000 | 当FinishStatus(基线实例完成状态)为FINISH(已完成)时,返回基线实例的完成时间戳。 |
ProjectId | Long | 1234 | 基线所在工作空间的ID。 |
Priority | Integer | 1 | 基线的优先级,取值范围为{1,2,5,7,8}。 |
EndCast | Long | 1553531400000 | 基线实例的预计完成时间。 |
InGroupId | Integer | 1 | 基线实例的周期号。天基线为1,小时基线的取值范围为[1,24]。 |
BaselineName | String | 基线名称 | 基线的名称。 |
BaselineId | Long | 1234 | 基线的ID。 |
FinishStatus | String | UNFINISH | 基线实例是否完成,包括UNFINISH(未完成)和FINISH(已完成)。 |
Bizdate | Long | 1553443200000 | 业务日期时间戳。 |
Buffer | Long | 1800 | 基线实例的余量,单位为秒。 |
SlaTime | Long | 1553531400000 | 基线实例的实际完成时间。 |
ExpTime | Long | 1553531400000 | 基线实例的预警时间。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListBaselineStatuses
&PageNumber=1
&PageSize=10
&Bizdate=2020-07-07T00:00:00+0800
&Priority=1,3,5,7,8
&SearchText=基线名称搜索关键字
&Owner=9527952795****
&TopicId=1234
&FinishStatus=FINISH,UNFINISH
&Status=SAFE,DANGROUS,OVER
&BaselineTypes=DAILY,HOURLY
&公共请求参数
正常返回示例
XML
格式
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>基线名称</BaselineName>
<BaselineId>1234</BaselineId>
<FinishStatus>UNFINISH</FinishStatus>
<Bizdate>1553443200000</Bizdate>
<Buffer>1800</Buffer>
<SlaTime>1553531400000</SlaTime>
<ExpTime>1553531400000</ExpTime>
</BaselineStatuses>
</Data>
</ListBaselineStatusesResponse>
JSON
格式
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" : "基线名称",
"BaselineId" : 1234,
"FinishStatus" : "UNFINISH",
"Bizdate" : 1553443200000,
"Buffer" : 1800,
"SlaTime" : 1553531400000,
"ExpTime" : 1553531400000
} ]
}
}
错误码
HttpCode |
错误码 |
错误信息 |
描述 |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | 没有权限,请授权 |
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.System | The DataWorks system is busy. Try again later. | DataWorks系统繁忙,请稍后再试。 |
429 | Throttling.User | Your request is too frequent. Try again later. | 您的请求过于频繁,请尝试放缓请求速度。 |
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. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。