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

Updating a Big Data Asset

Function

This API is used to update information about a specified big data asset. The updated asset details can be submitted in JSON format.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/sdg/asset/bigdata/{bigdata_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

bigdata_id

Yes

String

Big data asset ID, which uniquely identifies the asset to be updated.

project_id

Yes

String

Project ID, which is used to identify a specific project.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

asset_name

No

String

Asset name.

create_time

No

Long

Asset creation time, in milliseconds.

ds_address

No

String

Data source address.

ds_name

No

String

Data source name.

ds_password

No

String

Data source password.

ds_port

No

Integer

Data source port.

ds_type

No

String

Data source type. Types: Elasticsearch, DLI, Hive, HBase, MRS_HIVE, ALL, LTS, HIVE_ONLY, and JUST_BIG_DATA

ds_user

No

String

Data source username.

ds_version

No

String

Data source version.

ins_id

No

String

Instance ID.

ins_name

No

String

Instance name.

ins_type

No

String

Instance type. Types: Elasticsearch, DLI, Hive, HBase, MRS_HIVE, ALL, LTS, HIVE_ONLY, and JUST_BIG_DATA

lts_group_id

No

String

Log group ID.

lts_group_name

No

String

Log group name.

lts_stream_id

No

String

Log stream ID.

lts_stream_name

No

String

Log stream name.

queue_name

No

String

Queue name.

region

No

String

Region information.

scan_metadata

No

Boolean

Whether to scan metadata.

security_group_id

No

String

Security group ID.

subnet_id

No

String

Subnet ID.

vpc_id

No

String

VPC ID.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

msg

String

Returned message, which is used to describe the operation result or error information.

status

String

Return status, for example, '200', '400'.

Status code: 201

The big data asset is updated.

Example Requests

PUT /v1/{project_id}/sdg/asset/bigdata/{bigdata_id}

{
  "asset_name" : "string",
  "create_time" : 0,
  "ds_address" : "string",
  "ds_name" : "string",
  "ds_password" : "string",
  "ds_port" : 0,
  "ds_type" : "string",
  "ds_user" : "string",
  "ds_version" : "string",
  "ins_id" : "string",
  "ins_name" : "string",
  "ins_type" : "string",
  "lts_group_id" : "string",
  "lts_group_name" : "string",
  "lts_stream_id" : "string",
  "lts_stream_name" : "string",
  "queue_name" : "string",
  "region" : "string",
  "scan_metadata" : true,
  "security_group_id" : "string",
  "subnet_id" : "string",
  "vpc_id" : "string"
}

Example Responses

None

Status Codes

Status Code

Description

200

The big data asset is updated.

201

The big data asset is updated.

401

Unauthorized access. The request is rejected.

403

Unauthorized operation. The request is rejected.

404

The big data asset or project does not exist. Update failed.

Error Codes

See Error Codes.