Updated on 2024-08-02 GMT+08:00

Killing Physical Sessions

Function

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

Constraints

None

URI

  • URL format

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

  • Parameter description
    Table 1 Parameter description

    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

    ID of the associated RDS DB instance.

Request

Table 2 Parameter description

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 Request body parameters

Parameter

Mandatory

Type

Description

process_ids

Yes

String

Session ID set.

Value range: 1 to 100.

Example Request

Delete a physical session of a DDM instance.

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

Response

  • Normal response
    Table 4 Response body parameters

    Parameter

    Type

    Description

    resp

    String

    Check whether the physical session is deleted.

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

    For details, see Abnormal Request Results.

Status Code

Error Codes

For details, see Error Codes.