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

Querying the Extension Version

Function

This API is used to query the extension version.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{domain_id}/agent-plugin/all-version

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

domain_id

Yes

String

Definition:

Tenant ID, that is, domain ID of a user.

Constraints:

N/A

Range:

The value consists of 32 characters, including digits and letters.

Default value:

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

plugin_name

Yes

String

Definition:

Extension name.

Constraints:

Enter only letters, digits, hyphens (-), and underscores (_).

Value range:

1 to 50 characters.

Default value:

N/A

offset

Yes

String

Definition:

Offset where the query starts. This parameter must be used together with limit.

Constraints:

N/A

Value range:

The offset value must be no less than 0.

Default value:

N/A

limit

Yes

String

Definition:

Number of records of each query.

Constraints:

N/A

Value range:

1–100.

Default value:

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition:

User token. Obtain a token (the value of the X-Subject-Token response header) by calling the IAM API for .

Constraints:

N/A

Value range:

N/A

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

offset

Integer

Definition:

Offset where the query starts.

Value range:

The offset value must be no less than 0.

limit

Integer

Definition:

Number of records of each query.

Value range:

The value is no less than 0.

total

Integer

Definition:

Total number of queried static rules.

Value range:

N/A

data

Array of strings

Definition:

Result set.

Value range:

N/A

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_msg

String

Parameter description:

Error message.

Value range:

N/A

error_code

String

Parameter description:

Error code.

Value range:

N/A

Example Requests

GET https://{endpoint}/v1/ce8df55870164338a72d7e828a966a2a/agent-plugin/all-version?plugin_name=apie_test&offset=0&limit=999

Example Responses

Status code: 200

OK

{
  "offset" : 0,
  "limit" : 10,
  "total" : 2,
  "data" : [ "0.0.2", "0.0.1" ]
}

Status Codes

Status Code

Description

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

404

Not Found

Error Codes

See Error Codes.