Help Center> RES> API Reference> API> Data Source> Modifying a Data Source

Modifying a Data Source

Function

This API is used to modify a specified data source.

URI

PUT /v2.0/{project_id}/workspaces/{workspace_id}/data-sources/{datasource_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

datasource_id

Yes

String

Data source ID

project_id

Yes

String

Project ID. For details on how to obtain the project ID, see Obtaining a Project ID.

workspace_id

Yes

String

Workspace ID

Table 2 Query parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. For details on how to obtain the user token, see Obtaining a User Token Through Password Authentication.

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Content type. The value is application/json.

Table 4 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Data source name, which is a string of 1 to 64 characters and contains letters, digits, underscores (_), and hyphens (-)

Minimum: 1

Maximum: 64

data_config

Yes

DataConfig object

Data settings

specs_config

Yes

SpecsConfig object

Computing specifications settings

Table 5 DataConfig

Parameter

Mandatory

Type

Description

offline

Yes

Offline object

Offline computing specifications

nearline

No

Nearline object

Nearline data source

Table 6 Offline

Parameter

Mandatory

Type

Description

user_url

Yes

String

User data URL

item_url

Yes

String

Item data URL

behavior_url

Yes

String

Behavior data URL

Table 7 Nearline

Parameter

Mandatory

Type

Description

item_topic

No

Topic object

Item topic

user_topic

No

Topic object

User topic

behavior_topic

No

Topic object

Behavior topic

Table 8 Topic

Parameter

Mandatory

Type

Description

name

No

String

Name

id

No

String

ID

Table 9 SpecsConfig

Parameter

Mandatory

Type

Description

offline

Yes

String

Offline computing specifications

nearline

No

String

Real-time computing specifications

rank

No

String

Deep learning computing specifications

online_tps

No

Integer

Max. number of concurrent online services

Response Parameters

Status code: 200

Table 10 Response body parameters

Parameter

Type

Description

is_success

Boolean

Whether the request is successful

message

String

Response message

error_code

String

Error code (This parameter is not returned when the request is successful.)

Example Requests

This API is used to modify a data source.

/v2.0/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/workspaces/testuuidxxxxxxxxxxxxxxxxxxxxxxxx/data-sources/testuuidxxxxxxxxxxxxxxxxxxxxxxxx

{
  "datasource_name" : "jby-test-datasourc1e",
  "data_config" : {
    "offline" : {
      "user_url" : "<OBS path for storing user data>",
      "item_url" : "<OBS path for storing item data>",
      "behavior_url" : "<OBS path for storing behavior data>"
    }
  },
  "specs_config" : {
    "offline" : "4CU",
    "nearline" : "8CU"
  }
}

Example Responses

Status code: 200

OK

{
  "is_success" : true,
  "message" : "Successed to update data source."
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.