Queries baseline instances affected by an event.

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 GetTopicInfluence

The operation that you want to perform. Set the value to GetTopicInfluence.

TopicId Long Yes 1234

The ID of the event.

Response parameters

Parameter Type Example Description
HttpStatusCode Integer 200

The HTTP status code returned.

RequestId String 0000-ABCD-EFG****

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

ErrorMessage String The specified parameters are invalid.

The error message returned.

ErrorCode String 1031203110005

The error code returned.

Success Boolean true

Indicates whether the request was successful.

Data Object

The list of baseline instances affected by the event.

TopicId Long 1234

The ID of the event.

Influences Array of Influences

The list of affected baseline instances.

Status String SAFE

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.

Owner String 952795****

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

BaselineName String Baseline name

The name of the baseline.

BaselineId Long 1234

The ID of the baseline.

Bizdate Long 1553356800000

The data timestamp of the baseline instance.

Buffer Long 360

The margin of the baseline instance. Unit: seconds.

ProjectId Long 1234

The ID of the workspace to which the baseline belongs.

Priority Integer 1

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

InGroupId Integer 1

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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetTopicInfluence
&TopicId=1234
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetTopicInfluenceResponse>
    <HttpStatusCode>200</HttpStatusCode>
    <RequestId>0000-ABCD-EFG****</RequestId>
    <ErrorMessage>The specified parameters are invalid.</ErrorMessage>
    <ErrorCode>1031203110005</ErrorCode>
    <Success>true</Success>
    <Data>
        <TopicId>1234</TopicId>
        <Influences>
            <Status>SAFE</Status>
            <Owner>952795****</Owner>
            <BaselineName>Baseline name</BaselineName>
            <BaselineId>1234</BaselineId>
            <Bizdate>1553356800000</Bizdate>
            <Buffer>360</Buffer>
            <ProjectId>1234</ProjectId>
            <Priority>1</Priority>
            <InGroupId>1</InGroupId>
        </Influences>
    </Data>
</GetTopicInfluenceResponse>

JSON format

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" : {
    "TopicId" : 1234,
    "Influences" : {
      "Status" : "SAFE",
      "Owner" : "952795****",
      "BaselineName" : "Baseline name",
      "BaselineId" : 1234,
      "Bizdate" : 1553356800000,
      "Buffer" : 360,
      "ProjectId" : 1234,
      "Priority" : 1,
      "InGroupId" : 1
    }
  }
}

Error codes

HTTP status code Error code Error message Description
429 Throttling.Api The request for this resource has exceeded your available limit. The error message returned because the number of requests for the resource has exceeded the upper limit.
429 Throttling.Api.Risk The request for this resource has exceeded your daily available limit. The error message returned because the number of requests per day for the resource has exceeded the upper limit.
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.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.
500 InternalError.Wkbench.ServiceError An internal error occurred. The error message returned because a service error has occurred.
500 Invalid.Wkbench.Parameter The specified parameters are invalid. The error message returned because the values of one or more parameters are invalid.
500 Invalid.Wkbench.TopicNotExist The topic does not exist. The error message returned because the event does not exist.

For a list of error codes, see Service error codes.