Queries the trend of the number of auto triggered node instances within a specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListInstanceAmount

The operation that you want to perform.

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

The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

ProjectId Long Yes 10000

The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID.

RegionId String Yes cn-shanghai

The region ID. For example, the ID of the China (Shanghai) region is cn-shanghai, and that of the China (Zhangjiakou) region is cn-zhangjiakou. The system automatically determines the value of this parameter based on the endpoint that is used to call the operation.

Response parameters

Parameter Type Example Description
InstanceCounts Array of IntanceCounts

The trend of the number of auto triggered node instances within the specified period of time.

Count Integer 9527

The number of auto triggered node instances.

Date Long 1623772800000

The data timestamp at which the number of auto triggered node instances was obtained. This value is a UNIX timestamp.

RequestId String 95279527adhfj****

The ID of the request. You can use the ID to troubleshoot issues.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListInstanceAmount
&BeginDate=2021-06-13T00:00:00+0800
&EndDate=2021-06-16T00:00:00+0800
&ProjectId=10000
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

<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 format

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

Error codes

HttpCode Error code Error message Description
500 Forbidden.Not.Server The dataworksAPI service is not available in this area. Please try it in another area. The error message returned because the DataWorks API is unavailable in this region. Try another region.
500 InternalError.System An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
500 InternalError.UserId.Missing An internal system error occurred. Try again later. The error message returned because an internal error has occurred. Try again later.
403 ResourceNotAuthorized.Api You are not authorized to access the resources. The error message returned because you are not authorized to access the resources.
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the maximum number of requests for the resource has been reached.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the maximum number of requests per day for the resource has been reached.
429 Throttling.Resource You have reached the limit for the resource. Please contact us by submitting a ticket. The error message returned because your quota for this resource has reached the upper limit. Submit a ticket for help.
429 Throttling.System The DataWorks system is busy. Try again later. The error message returned because the DataWorks system is busy. Try again later.
429 Throttling.User Your request is too frequent. Try again later. The error message returned because excessive requests have been submitted within a short period of time. Try again later.
500 Forbidden.Wkbench.NoProject You have not joined any project. The error message returned because you have not joined a workspace.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The error message returned because the values specified for one or more parameters are invalid.
403 Forbidden.Access Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition.

For a list of error codes, visit the API Error Center.