All Products
Search
Document Center

DataWorks:GetTopicInfluence

Last Updated:Sep 04, 2025

Queries baseline instances affected by an event.

Operation description

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
TopicIdlongYes

The ID of the event.

1234

Response parameters

ParameterTypeDescriptionExample
object
HttpStatusCodeinteger

The HTTP status code returned.

200
RequestIdstring

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

0000-ABCD-EFG****
ErrorMessagestring

The error message returned.

The specified parameters are invalid.
ErrorCodestring

The error code returned.

1031203110005
Successboolean

Indicates whether the request was successful.

true
Dataobject

The data returned.

TopicIdlong

The ID of the event.

1234
Influencesarray<object>

The affected baseline instances.

Influencesobject
Statusstring

The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.

SAFE
Ownerstring

The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).

952795****
BaselineNamestring

The name of the baseline.

Baseline name
BaselineIdlong

The ID of the baseline.

12345
Bizdatelong

The data timestamp of the baseline instance.

1553356800000
Bufferlong

The margin of the baseline instance. Unit: seconds.

360
ProjectIdlong

The ID of the workspace to which the baseline belongs.

1234
Priorityinteger

The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.

1
InGroupIdinteger

The ID of the cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.

1

Examples

Sample success responses

JSONformat

{ "HttpStatusCode": 200, "RequestId": "0000-ABCD-EFG****", "ErrorMessage": "The specified parameters are invalid.", "ErrorCode": 1031203110005, "Success": true, "Data": { "TopicId": 1234, "Influences": [ { "Status": "SAFE", "Owner": "952795****", "BaselineName": "Baseline name", "BaselineId": 12345, "Bizdate": 1553356800000, "Buffer": 360, "ProjectId": 1234, "Priority": 1, "InGroupId": 1 } ] } }

Error codes

HTTP status codeError codeError messageDescription
403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.No permission, please authorize
429Throttling.ApiThe request for this resource has exceeded your available limit.-
429Throttling.Api.RiskThe request for this resource has exceeded your daily available limit.-
429Throttling.SystemThe DataWorks system is busy. Try again later.-
429Throttling.UserYour request is too frequent. Try again later.-
500Forbidden.Not.ServerThe dataworksAPI service is not available in this area. Please try it in another area.-
500InternalError.SystemAn internal system error occurred. Try again later.-
500InternalError.UserId.MissingAn internal system error occurred. Try again later.-
500InternalError.Wkbench.ServiceErrorAn internal error occurred.An internal error occurred.
500Invalid.Wkbench.ParameterThe specified parameters are invalid.The specified parameters are invalid.
500Invalid.Wkbench.TopicNotExistThe topic does not exist.The topic does not exist.

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

Change history

Change timeSummary of changesOperation
No change history