Updated on 2026-05-30 GMT+08:00

Killing Logical Sessions (a V3 API)

Function

This API is used to delete logical sessions of a DDM instance.

Constraints

None

URI

  • URL format

    DELETE /v3/{project_id}/instances/{instance_id}/logical-processes

  • Parameter description
    Table 1 URI parameters

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID of a tenant in a region

    To obtain this value, see Obtaining a Project ID.

    instance_id

    Yes

    String

    DDM instance ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

You can obtain the token by calling the IAM API used to obtain a user token.

Table 3 Parameter description

Parameter

Mandatory

Type

Description

process_ids

Yes

Array of strings

Session ID set.

Value range: 1 to 100.

Example Request

This API is used to delete logical sessions of a DDM instance.

DELETE https://{endpoint}/v3/{project_id}/instances/{instance_id}/logical-processes
{
  "process_ids": [
    "12312"
  ]
}

Response

  • Normal response
    Table 4 Response body parameters

    Parameter

    Type

    Description

    resp

    String

    Check whether a logical session is deleted.

  • Normal response example
    {
      "resp": "successful"
    }

Status Code

Error Codes

For details, see Error Codes.