Updated on 2024-10-25 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}/drivers

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a tenant in a region.

For details about how to obtain the project ID, 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.

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.

driver_type

Yes

String

The type of the driver file to be queried. Values:

  • db2: Db2 for LUW
  • informix: Informix

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.

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.

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/drivers?limit=10&offset=0&driver_type=db2

Example Response

Status code: 200

OK

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

Status Code

Status Code

Description

200

OK

Error Code

For details, see Error Code.