Help Center> SecMaster> API Reference> API> Incident Relationship Management> Canceling Association with a Data Object
Updated on 2024-03-20 GMT+08:00

Canceling Association with a Data Object

Function

Canceling Association with a Data Object

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/{dataclass_type}/{data_object_id}/{related_dataclass_type}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Minimum: 32

Maximum: 36

workspace_id

Yes

String

Workspace ID

Minimum: 32

Maximum: 36

dataclass_type

Yes

String

Data class to which the associated subject data object belongs. The value is plural in lowercase, for example, "alerts" and "incidents".

Minimum: 1

Maximum: 64

data_object_id

Yes

String

ID of the associated data object.

Minimum: 32

Maximum: 36

related_dataclass_type

Yes

String

Data class to which the associated subject data object belongs. The value is plural in lowercase, for example, "alerts" and "incidents".

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Minimum: 0

Maximum: 2097152

content-type

Yes

String

Content type.

Default: application/json;charset=UTF-8

Minimum: 0

Maximum: 64

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

ids

No

Array of strings

ID list of associated data objects.

Minimum: 32

Maximum: 64

Array Length: 0 - 100

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code

Minimum: 0

Maximum: 64

message

String

Error Message

Minimum: 0

Maximum: 1024

data

BatchOperateDataobjectResult object

Returned object for batch operation on alerts.

Table 6 BatchOperateDataobjectResult

Parameter

Type

Description

error_ids

Array of strings

IDs of alerts not transferred to incidents

Minimum: 0

Maximum: 100

Array Length: 0 - 100

success_ids

Array of strings

IDs of alerts transferred to incidents.

Minimum: 0

Maximum: 100

Array Length: 0 - 100

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.

Table 8 Response body parameters

Parameter

Type

Description

code

String

Error Code

Minimum: 0

Maximum: 64

message

String

Error Description

Minimum: 0

Maximum: 1024

Example Requests

Delete an incident relationship. Incident ID is f60bf0e7-73b8-4832-8fc4-8c2a12830552.

{
  "ids" : [ "f60bf0e7-73b8-4832-8fc4-8c2a12830552" ]
}

Example Responses

Status code: 200

Response body for the request for canceling associating a data object.

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "Error message",
  "request_id" : "Error message",
  "success" : false,
  "total" : 41,
  "limit" : 3,
  "offset" : 10,
  "data" : {
    "success_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
    "error_ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ]
  }
}

SDK Sample Code

The SDK sample code is as follows.

Delete an incident relationship. Incident ID is f60bf0e7-73b8-4832-8fc4-8c2a12830552.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.secmaster.v2.region.SecMasterRegion;
import com.huaweicloud.sdk.secmaster.v2.*;
import com.huaweicloud.sdk.secmaster.v2.model.*;

import java.util.List;
import java.util.ArrayList;

public class DeleteDataobjectRelationsSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");

        ICredential auth = new BasicCredentials()
                .withAk(ak)
                .withSk(sk);

        SecMasterClient client = SecMasterClient.newBuilder()
                .withCredential(auth)
                .withRegion(SecMasterRegion.valueOf("<YOUR REGION>"))
                .build();
        DeleteDataobjectRelationsRequest request = new DeleteDataobjectRelationsRequest();
        CreateDataobjectRelationsRequestBody body = new CreateDataobjectRelationsRequestBody();
        List<String> listbodyIds = new ArrayList<>();
        listbodyIds.add("f60bf0e7-73b8-4832-8fc4-8c2a12830552");
        body.withIds(listbodyIds);
        request.withBody(body);
        try {
            DeleteDataobjectRelationsResponse response = client.deleteDataobjectRelations(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

Delete an incident relationship. Incident ID is f60bf0e7-73b8-4832-8fc4-8c2a12830552.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# coding: utf-8

from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdksecmaster.v2.region.secmaster_region import SecMasterRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdksecmaster.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = __import__('os').getenv("CLOUD_SDK_AK")
    sk = __import__('os').getenv("CLOUD_SDK_SK")

    credentials = BasicCredentials(ak, sk) \

    client = SecMasterClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = DeleteDataobjectRelationsRequest()
        listIdsbody = [
            "f60bf0e7-73b8-4832-8fc4-8c2a12830552"
        ]
        request.body = CreateDataobjectRelationsRequestBody(
            ids=listIdsbody
        )
        response = client.delete_dataobject_relations(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

Delete an incident relationship. Incident ID is f60bf0e7-73b8-4832-8fc4-8c2a12830552.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    secmaster "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/secmaster/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := secmaster.NewSecMasterClient(
        secmaster.SecMasterClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.DeleteDataobjectRelationsRequest{}
	var listIdsbody = []string{
        "f60bf0e7-73b8-4832-8fc4-8c2a12830552",
    }
	request.Body = &model.CreateDataobjectRelationsRequestBody{
		Ids: &listIdsbody,
	}
	response, err := client.DeleteDataobjectRelations(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.

Status Codes

Status Code

Description

200

Response body for the request for canceling associating a data object.

400

Response body for failed requests for canceling associating a data object.

Error Codes

See Error Codes.