All Products
Search
Document Center

DataWorks:ListMeasureData

Last Updated:Oct 17, 2024

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
DomainCodestringYes

The item to be measured. Valid values:

  • DideAlarmPhone: phone call-based alerts
  • DideAlarmSms: text message-based alerts
DideAlarmPhone
ComponentCodestringYes

The measurement component.

  • This parameter is set to Count if the DomainCode parameter is set to DideAlarmPhone or DideAlarmSms. In this case, statistics on the number of phone calls or text messages that are used to send alert notifications are collected.
Count
StartTimelongYes

The start timestamp of the measurement period, in milliseconds. The measurement period is calculated in days. You can query only the data within the last 30 days.

1717344000000
EndTimelongYes

The end timestamp of the measurement period, in milliseconds. The measurement period is calculated in days. You can query only the data within the last 30 days.

1717430400000

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

1AFAE64E-D1BE-432B-A9****
MeasureDatasarray<object>

The measurement results.

MeasureDataobject
DomainCodestring

The item that is measured.

DideAlarmPhone
ComponentCodestring

The measurement component.

Count
StartTimelong

The start timestamp of the measurement period, in milliseconds.

1717344000000
EndTimelong

The end timestamp of the measurement period, in milliseconds.

1717430400000
Usagelong

The total quantity used within the measurement period.

10
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

100001001
ErrorMessagestring

The error message.

The user is not in tenant.
HttpStatusCodeinteger

The HTTP status code.

200

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AFAE64E-D1BE-432B-A9****",
  "MeasureDatas": [
    {
      "DomainCode": "DideAlarmPhone",
      "ComponentCode": "Count",
      "StartTime": 1717344000000,
      "EndTime": 1717430400000,
      "Usage": 10
    }
  ],
  "Success": true,
  "ErrorCode": "100001001",
  "ErrorMessage": "The user is not in tenant.",
  "HttpStatusCode": 200
}

Error codes

HTTP status codeError codeError messageDescription
403Invalid.Tenant.UserNotInTenantThe user is not in tenant.The user is not in tenant.

For a list of error codes, visit the Service error codes.