调用ListInstanceAmount获取指定时间段周期实例数量的趋势。

调试

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

请求参数

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

要执行的操作。

BeginDate String 2021-06-13T00:00:00+0800

开始业务日期,精确到天。该参数需要配置为yyyy-MM-dd'T'HH:mm:ssZ的UTC格式。

EndDate String 2021-06-16T00:00:00+0800

结束业务日期,精确到天。该参数需要配置为yyyy-MM-dd'T'HH:mm:ssZ的UTC格式。

ProjectId Long 10000

DataWorks工作空间的ID。您可以登录DataWorks管控台,进入工作空间配置页面获取工作空间ID。

RegionId String cn-shanghai

地域信息,通常为服务所在的地域。例如,华东2(上海)为cn-shanghai,华北3(张家口)为cn-zhangjiakou。您无需填写RegionId,会根据调用的Endpoint自动解析。

返回数据

名称 类型 示例值 描述
InstanceCounts Array of IntanceCounts

周期实例数量在指定时间段的趋势数据。

Count Integer 9527

周期实例的数量。

Date Long 1623772800000

获取周期实例数量的业务日期,此处显示业务日期对应的时间戳。

RequestId String 95279527adhfj****

请求ID。用于出现错误后排查问题。

示例

请求示例

http(s)://[Endpoint]/?Action=ListInstanceAmount
&BeginDate=2021-06-13T00:00:00+0800
&EndDate=2021-06-16T00:00:00+0800
&ProjectId=10000
&RegionId=cn-shanghai
&<公共请求参数>

正常返回示例

XML格式

<RequestId>95279527adhfj****</RequestId>
<InstanceCounts>
    <Count>319</Count>
    <Date>1623513600000</Date>
</InstanceCounts>
<InstanceCounts>
    <Count>320</Count>
    <Date>1623600000000</Date>
</InstanceCounts>
<InstanceCounts>
    <Count>320</Count>
    <Date>1623686400000</Date>
</InstanceCounts>
<InstanceCounts>
    <Count>320</Count>
    <Date>1623772800000</Date>
</InstanceCounts>

JSON格式

{
  "RequestId": "95279527adhfj****",
  "InstanceCounts": [
    {
      "Count": 319,
      "Date": 1623513600000
    },
    {
      "Count": 320,
      "Date": 1623600000000
    },
    {
      "Count": 320,
      "Date": 1623686400000
    },
    {
      "Count": 320,
      "Date": 1623772800000
    }
  ]
}

错误码

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. 系统内部错误,请稍后再试。
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. 尚未加入任何工作空间。
500 Invalid.Wkbench.Parameter The specified parameters are invalid. 参数错误。
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. 您被限制访问,请开通DataWorks企业版或旗舰版。

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