Updated on 2025-08-06 GMT+08:00

Editing a Data Source

Function

This API is used to edit a data source.

Calling Method

For details, see Calling APIs.

URI

PUT /v1.0/{project_id}/clusters/{cluster_id}/ext-data-sources/{ext_data_source_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

ext_data_source_id

Yes

String

Definition

Data source ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

reconfigure

Yes

ReconfigureExtDataSourceAction object

Definition

Data source configuration.

Range

N/A

Table 3 ReconfigureExtDataSourceAction

Parameter

Mandatory

Type

Description

reboot

No

Boolean

Definition

Reboot.

Range

N/A

agency

No

String

Definition

Agency.

Range

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

job_id

String

Definition

ID of the task for updating a data source.

Range

N/A

data_source_id

String

Definition

Data source ID.

Range

N/A

Example Requests

Change the agency name to DWSAccessOBS for the data source whose ID is d303f19c-fbd1-4716-ae04-07d1ff358f22.

PUT https://{Endpoint} /v1.0/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/ext-data-sources/d303f19c-fbd1-4716-ae04-07d1ff358f22

Example Responses

Status code: 200

Request submitted.

{
  "data_source_id" : "d303f19c-fbd1-4716-ae04-07d1ff358f22",
  "job_id" : "2c9081c88418ed420184197c8bc80001"
}

Status Codes

Status Code

Description

200

Request submitted.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.