Updated on 2026-01-20 GMT+08:00

Batch Deleting Listeners

Function

This API is used to batch delete listeners.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v3/{project_id}/elb/listeners/batch-delete

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition: Specifies the project ID. For details about how to obtain a project ID, see Obtaining a Project ID.

Constraints: N/A

Range: The value can contain a maximum of 32 characters, including digits and lowercase letters.

Default value: N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition: Specifies the token used for IAM authentication.

Constraints: N/A

Range: N/A

Default value: N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

listener_ids

Yes

Array of strings

Definition: Specifies the IDs of the listeners to be deleted.

Constraints: A maximum of 10 listeners can be deleted at a time.

Range: N/A

Default value: N/A

Response Parameters

Status code: 202

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Specifies the ID of the batch deletion task.

listener_ids

Array of strings

Specifies the IDs of the listeners to be deleted.

Example Requests

Batch deleting listeners

POST https://{ELB_Endpoint}/v3/{project_id}/elb/listeners/batch-delete

{
  "listener_ids" : [ "5b2513ca-3290-46ad-b723-e47afb83b4d2", "c2d6bfd6-4eae-4995-8e5d-711fa592744c" ]
}

Example Responses

Status code: 202

Successful request.

{
  "job_id" : "6b76f5cb-cab8-48e2-919a-0ff55d230051",
  "listener_ids" : [ "5b2513ca-3290-46ad-b723-e47afb83b4d2", "c2d6bfd6-4eae-4995-8e5d-711fa592744c" ]
}

Status Codes

Status Code

Description

202

Successful request.

Error Codes

See Error Codes.