调用ListBaselineConfigs获取基线列表。

调试

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

请求参数

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

要执行的操作。

PageNumber Integer 1

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

PageSize Integer 10

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

ProjectId Long 1234

工作空间的ID。

RegionId String cn-shanghai

可用区的唯一标识。

Owner String 95279527****

基线责任人阿里云UID。

Priority String 1,3,5,7,8

基线的优先级,取值范围为{1,3,5,7,8} 。多个优先级之间使用英文逗号(,)分隔。

Useflag Boolean true

是否开启,包括true(开启)和false(未开启)。

BaselineTypes String DAILY,HOURLY

基线类型,包括DAILY(天基线)和HOURLY(小时基线)。多个类型之间使用英文逗号(,)分隔。

SearchText String 基线名称搜索关键字

基线名称的搜索关键字。

返回数据

名称 类型 示例值 描述
Data Struct

返回的基线列表。

Baselines Array of Baselines

基线列表。

BaselineId Long 1234

基线的ID。

BaselineName String 基线名称

基线的名称。

BaselineType String DAILY

基线类型,包括DAILY(天基线)和HOURLY(小时基线)。

ExpHour Integer 7

天基线的预警小时,取值范围为[0, 47]。

ExpMinu Integer 30

天基线的预警分钟,取值范围为[0, 59]。

HourExpDetail String {"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}

小时基线的预警时间配置(JSON格式),key为周期号,value为hh:mm格式。hh的取值范围为[0,47],mm的取值范围为[0,59]。

HourSlaDetail String {"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}

小时基线的承诺时间配置(JSON格式),key为周期号,value为hh:mm格式。hh的取值范围为[0,47],mm的取值范围为[0,59]。

IsDefault Boolean true

是否为工作空间的默认基线,包括true(是)和false(否)。

Owner String 952795****

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

Priority Integer 1

基线的优先级,取值集合为{1,3,5,7,8}。

ProjectId Long 9527

基线所在工作空间的ID。

SlaHour Integer 9

天基线的承诺小时,取值范围为[0, 47]。

SlaMinu Integer 30

天基线的预警分钟,取值范围为[0, 59]。

UseFlag Boolean true

基线是否开启,包括true(开启)和false(未开启)。

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=ListBaselineConfigs
&PageNumber=1
&PageSize=10
&ProjectId=1234
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML 格式

<RequestId>0000-ABCD-EFG****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>100</TotalCount>
    <PageSize>10</PageSize>
    <PageNumber>1</PageNumber>
    <Baselines>
        <BaselineId>1234</BaselineId>
        <IsDefault>true</IsDefault>
        <ExpHour>7</ExpHour>
        <HourSlaDetail>{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}</HourSlaDetail>
        <Owner>952795****</Owner>
        <ExpMinu>30</ExpMinu>
        <SlaHour>9</SlaHour>
        <Priority>1</Priority>
        <SlaMinu>30</SlaMinu>
        <ProjectId>1234</ProjectId>
        <HourExpDetail>{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}</HourExpDetail>
        <UseFlag>true</UseFlag>
        <BaselineType>DAILY</BaselineType>
        <BaselineName>基线名称</BaselineName>
    </Baselines>
</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,
        "Baselines": {
            "BaselineId": 1234,
            "IsDefault": true,
            "ExpHour": 7,
            "HourSlaDetail": "{\"1\":\"03:58\",\"2\":\"04:58\",\"3\":\"05:58\",\"4\":\"06:58\",\"5\":\"07:58\",\"6\":\"08:58\",\"7\":\"09:58\",\"8\":\"10:58\",\"9\":\"11:58\",\"10\":\"12:58\",\"11\":\"13:58\",\"12\":\"14:58\",\"13\":\"15:58\",\"14\":\"16:58\",\"15\":\"17:58\",\"16\":\"18:58\",\"17\":\"19:58\",\"18\":\"20:58\",\"19\":\"21:58\",\"20\":\"22:58\",\"21\":\"23:58\",\"22\":\"24:58\",\"23\":\"25:58\",\"24\":\"26:58\"}",
            "Owner": "952795****",
            "ExpMinu": 30,
            "SlaHour": 9,
            "Priority": 1,
            "SlaMinu": 30,
            "ProjectId": 1234,
            "HourExpDetail": "{\"1\":\"03:28\",\"2\":\"04:28\",\"3\":\"05:28\",\"4\":\"06:28\",\"5\":\"07:28\",\"6\":\"08:28\",\"7\":\"09:28\",\"8\":\"10:28\",\"9\":\"11:28\",\"10\":\"12:28\",\"11\":\"13:28\",\"12\":\"14:28\",\"13\":\"15:28\",\"14\":\"16:28\",\"15\":\"17:28\",\"16\":\"18:28\",\"17\":\"19:28\",\"18\":\"20:28\",\"19\":\"21:28\",\"20\":\"22:28\",\"21\":\"23:28\",\"22\":\"24:28\",\"23\":\"25:28\",\"24\":\"26:28\"}",
            "UseFlag": true,
            "BaselineType": "DAILY",
            "BaselineName": "基线名称"
        }
    },
    "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 Forbidden.Wkbench.ProjectNoPermission You are not authorized to access the workspace. 工作空间无权限。
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.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. 您的请求过于频繁,请尝试放缓请求速度。
500 Forbidden.Wkbench.NoProject You have not joined any project. 尚未加入任何工作空间。

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