Updated on 2024-05-27 GMT+08:00

Querying the Driver File List

Function

This API is used to query the driver file list.

Constraints

  • This API is available only in the synchronization scenario where DB2 for LUW serves as the source database.
  • This API can be used only in certain regions. For details, see Endpoints.

URI

GET /v5/{project_id}/jdbc-drivers

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details, see Obtaining a Project ID.

Table 2 Query parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Number of items displayed per page. The default value is 10. The value ranges from 1 to 1000.

Minimum value: 1

Maximum value: 1000

Default value: 10

offset

No

Integer

Offset, which is the position where the query starts. The value must be greater than or equal to 0. The default value is 0.

Default value: 0

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

MIME type of the request body. Use the default value application/json. For APIs used to upload objects or images, the value varies depending on the flow type.

The default value is application/json.

X-Auth-Token

Yes

String

User token obtained from IAM.

It is a response to the API for obtaining a user token. This API is the only one that does not require authentication.

After a request is processed, the value of X-Subject-Token in the header is the token value.

X-Language

No

String

Request language type.

Default value: en-us

Enumerated values:

  • en-us
  • zh-cn

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total number of driver files.

items

Array of DriverInfo objects

Driver file list.

Table 5 DriverInfo

Parameter

Type

Description

driver_name

String

File name.

last_modified

String

Last modification time.

size

Integer

File size, in bytes.

Example Request

Obtaining the driver file list

https://{endpoint}/v5/5237e10fe9aa4ad5b16b6a5245248314/jdbc-drivers?limit=10&offset=0

Example Response

Status code: 200

OK

{
  "count" : 10,
  "items" : [ {
    "driver_name" : "db2jcc_*****.jar",
    "size" : 102400000,
    "last_modified" : "2020-09-01T18:50:20Z"
  } ]
}

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.