Canceling the Association with a Data Object
Function
This API is used to cancel the 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}
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID Constraints N/A Range N/A Default Value N/A |
|
workspace_id |
Yes |
String |
Definition Workspace ID. Constraints N/A Range N/A Default Value N/A |
|
dataclass_type |
Yes |
String |
Data class the association subject data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents". |
|
data_object_id |
Yes |
String |
ID of the associated data object. |
|
related_dataclass_type |
Yes |
String |
Data class the associated data object belongs to. The value must be plural and written in lowercase, for example, "alerts" and "incidents". |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
Definition User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token Constraints N/A Range N/A Default Value N/A |
|
content-type |
Yes |
String |
Definition Content type.
Constraints N/A Range
Default Value N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
ids |
No |
Array of strings |
The ID list of associated data objects. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Error code. |
|
message |
String |
Error message. |
|
data |
BatchOperateDataobjectResult object |
Returned object for batch operation on alerts. |
|
Parameter |
Type |
Description |
|---|---|---|
|
error_ids |
Array of strings |
Failed IDs. |
|
success_ids |
Array of strings |
Succeeded IDs. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
X-request-id |
String |
Request ID. Format: request_uuid-timestamp-hostname. |
|
Parameter |
Type |
Description |
|---|---|---|
|
code |
String |
Definition Error code. Range N/A |
|
message |
String |
Definition Error description. Range N/A |
Example Requests
Delete an incident relationship. Incident ID: f60bf0e7-73b8-4832-8fc4-8c2a12830552.
{
"ids" : [ "f60bf0e7-73b8-4832-8fc4-8c2a12830552" ]
}
Example Responses
Status code: 200
Response body for the request for canceling the association with 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.
Java
Delete an incident relationship. Incident ID: 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 53 54 55 56 57 58 |
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"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); SecMasterClient client = SecMasterClient.newBuilder() .withCredential(auth) .withRegion(SecMasterRegion.valueOf("<YOUR REGION>")) .build(); DeleteDataobjectRelationsRequest request = new DeleteDataobjectRelationsRequest(); request.withWorkspaceId("{workspace_id}"); request.withDataclassType("{dataclass_type}"); request.withDataObjectId("{data_object_id}"); request.withRelatedDataclassType("{related_dataclass_type}"); 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()); } } } |
Python
Delete an incident relationship. Incident ID: 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 |
# coding: utf-8 import os 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 = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = SecMasterClient.new_builder() \ .with_credentials(credentials) \ .with_region(SecMasterRegion.value_of("<YOUR REGION>")) \ .build() try: request = DeleteDataobjectRelationsRequest() request.workspace_id = "{workspace_id}" request.dataclass_type = "{dataclass_type}" request.data_object_id = "{data_object_id}" request.related_dataclass_type = "{related_dataclass_type}" 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) |
Go
Delete an incident relationship. Incident ID: 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 |
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") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := secmaster.NewSecMasterClient( secmaster.SecMasterClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.DeleteDataobjectRelationsRequest{} request.WorkspaceId = "{workspace_id}" request.DataclassType = "{dataclass_type}" request.DataObjectId = "{data_object_id}" request.RelatedDataclassType = "{related_dataclass_type}" 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) } } |
More
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 the association with a data object. |
|
400 |
Response body for failed requests for canceling the association with a data object. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot