调用ListBaselineStatuses获取基线实例列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListBaselineStatuses

要执行的操作。

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

业务日期,需要使用UTC格式(yyyy-MM-dd'T'HH:mm:ssZ)。

PageNumber Integer 1

分页的页数。默认值为1,最小值为1,最大值为30。

PageSize Integer 10

每页返回的数据行数。默认值为10,最小值为1,最大值为100。

RegionId String cn-shanghai

可用区的唯一标识。

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(小时基线)。多个类型之间使用英文逗号(,)分隔。

返回数据

名称 类型 示例值 描述
Data Struct

返回的基线实例列表。

BaselineStatuses Array

基线实例列表。

BaselineId Long 1234

基线的ID。

BaselineName String 基线名称

基线的名称。

Bizdate Long 1553443200000

业务日期时间戳。

Buffer Long 1800

基线实例的余量,单位为秒。

EndCast Long 1553531400000

基线实例的预计完成时间。

ExpTime Long 1553531400000

基线实例的预警时间。

FinishStatus String UNFINISH

基线实例是否完成,包括UNFINISH(未完成)和FINISH(已完成)。

FinishTime Long 1553531400000

当FinishStatus(基线实例完成状态)为FINISH(已完成)时,返回基线实例的完成时间戳。

InGroupId Integer 1

基线实例的周期号。天基线为1,小时基线的取值范围为[1,24]。

Owner String 9527952795****

基线责任人的阿里云UID。多个责任人之间使用英文逗号(,)分隔。

Priority Integer 1

基线的优先级,取值范围为{1,2,5,7,8}。

ProjectId Long 1234

基线所在工作空间的ID。

SlaTime Long 1553531400000

基线实例的实际完成时间。

Status String SAFE

基线的状态,包括ERROR(异常)、SAFE(安全)、DANGROUS(预警)和OVER(破线)。

PageNumber Integer 1

当前的页数。

PageSize Integer 10

每页的大小。

TotalCount Integer 100

基线实例的总数。

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=ListBaselineStatuses
&Bizdate=2020-07-07T00:00:00+0800
&PageNumber=1
&PageSize=10
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <BaselineStatuses>
        <BaselineId>1234</BaselineId>
        <Buffer>1800</Buffer>
        <Status>SAFE</Status>
        <Owner>9527952795****</Owner>
        <Priority>1</Priority>
        <FinishStatus>UNFINISH</FinishStatus>
        <ProjectId>1234</ProjectId>
        <Bizdate>1553443200000</Bizdate>
        <ExpTime>1553531400000</ExpTime>
        <InGroupId>1</InGroupId>
        <FinishTime>1553531400000</FinishTime>
        <BaselineName>基线名称</BaselineName>
        <SlaTime>1553531400000</SlaTime>
        <EndCast>1553531400000</EndCast>
    </BaselineStatuses>
</Data>
<ErrorCode>1031203110005</ErrorCode>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<Success>true</Success>

JSON 格式

{
    "RequestId": "0000-ABCD-EFG****",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 100,
        "PageSize": 10,
        "PageNumber": 1,
        "BaselineStatuses": {
            "BaselineId": 1234,
            "Buffer": 1800,
            "Status": "SAFE",
            "Owner": "9527952795****",
            "Priority": 1,
            "FinishStatus": "UNFINISH",
            "ProjectId": 1234,
            "Bizdate": 1553443200000,
            "ExpTime": 1553531400000,
            "InGroupId": 1,
            "FinishTime": 1553531400000,
            "BaselineName": "基线名称",
            "SlaTime": 1553531400000,
            "EndCast": 1553531400000
        }
    },
    "ErrorCode": 1031203110005,
    "ErrorMessage": "The specified parameters are invalid.",
    "Success": true
}

错误码

HttpCode 错误码 错误信息 描述
403 Forbidden.Access Access is forbidden. Activate DataWorks first. 您被限制访问,可能是由于您还未激活DataWorks。
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. 参数错误。
403 ResourceNotAuthorized.Api You are not authorized to access the resources. 您无法访问未取得授权的资源。
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. 您的请求过于频繁,请尝试放缓请求速度。

访问错误中心查看更多错误码。