调用ListBaselineConfigs获取基线列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListBaselineConfigs | 系统规定参数。取值:ListBaselineConfigs。 |
PageNumber | Integer | 是 | 1 | 分页的页数。默认值为1,最小值为1,最大值为30。 |
PageSize | Integer | 是 | 10 | 每页返回的数据行数。默认值为10,最小值为1,最大值为100。 |
Owner | String | 否 | 95279527**** | 基线责任人的阿里云UID。 |
ProjectId | Long | 是 | 1234 | 工作空间的ID。您可以通过ListProjects接口获取工作空间ID。 |
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 | 否 | 基线名称搜索关键字 | 基线名称的搜索关键字。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
HttpStatusCode | Integer | 200 | HTTP返回码。 |
RequestId | String | 0000-ABCD-EFG**** | 本次调用的唯一ID。出现错误后,您可以根据该ID排查问题。 |
ErrorMessage | String | The specified parameters are invalid. | 错误信息。 |
ErrorCode | String | 1031203110005 | 错误码。 |
Success | Boolean | true | 调用是否成功。 |
Data | Object | 返回的基线列表。 |
|
PageNumber | Integer | 1 | 当前的页数。 |
PageSize | Integer | 10 | 每页的大小。 |
TotalCount | Integer | 100 | 基线的总数。 |
Baselines | Array of Baselines | 基线列表。 |
|
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。有多个责任人时,使用英文逗号(,)分隔。 |
ProjectId | Long | 9527 | 基线所在工作空间的ID。 |
Priority | Integer | 1 | 基线的优先级,取值集合为{1,3,5,7,8}。 |
SlaMinu | Integer | 30 | 天基线的预警分钟,取值范围为[0, 59]。 |
SlaHour | Integer | 9 | 天基线的承诺小时,取值范围为[0, 47]。 |
BaselineId | Long | 1234 | 基线的ID。 |
BaselineName | String | 基线名称 | 基线的名称。 |
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]。 |
UseFlag | Boolean | true | 基线是否开启,包括true(开启)和false(未开启)。 |
ExpHour | Integer | 7 | 天基线的预警小时,取值范围为[0, 47]。 |
BaselineType | String | DAILY | 基线类型,包括DAILY(天基线)和HOURLY(小时基线)。 |
ExpMinu | Integer | 30 | 天基线的预警分钟,取值范围为[0, 59]。 |
示例
请求示例
http(s)://[Endpoint]/?Action=ListBaselineConfigs
&PageNumber=1
&PageSize=10
&Owner=95279527****
&ProjectId=1234
&Priority=1,3,5,7,8
&Useflag=true
&BaselineTypes=DAILY,HOURLY
&SearchText=基线名称搜索关键字
&公共请求参数
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<ListBaselineConfigsResponse>
<HttpStatusCode>200</HttpStatusCode>
<RequestId>0000-ABCD-EFG****</RequestId>
<ErrorMessage>The specified parameters are invalid.</ErrorMessage>
<ErrorCode>1031203110005</ErrorCode>
<Success>true</Success>
<Data>
<PageNumber>1</PageNumber>
<PageSize>10</PageSize>
<TotalCount>100</TotalCount>
<Baselines>
<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>
<IsDefault>true</IsDefault>
<Owner>952795****</Owner>
<ProjectId>9527</ProjectId>
<Priority>1</Priority>
<SlaMinu>30</SlaMinu>
<SlaHour>9</SlaHour>
<BaselineId>1234</BaselineId>
<BaselineName>基线名称</BaselineName>
<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>
<ExpHour>7</ExpHour>
<BaselineType>DAILY</BaselineType>
<ExpMinu>30</ExpMinu>
</Baselines>
</Data>
</ListBaselineConfigsResponse>
JSON
格式
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" : {
"PageNumber" : 1,
"PageSize" : 10,
"TotalCount" : 100,
"Baselines" : {
"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\"}",
"IsDefault" : true,
"Owner" : "952795****",
"ProjectId" : 9527,
"Priority" : 1,
"SlaMinu" : 30,
"SlaHour" : 9,
"BaselineId" : 1234,
"BaselineName" : "基线名称",
"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,
"ExpHour" : 7,
"BaselineType" : "DAILY",
"ExpMinu" : 30
}
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
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. | 系统内部错误,请稍后再试。 |
访问错误中心查看更多错误码。