All Products
Search
Document Center

DataWorks:UpdateParameter

Last Updated:Apr 20, 2026

Updates a parameter. This operation performs an incremental update and modifies only the specified fields.

Operation description

This operation is available only in DataWorks Professional Edition and later.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

Id

integer

Yes

The parameter ID.

12345

Properties

array<object>

No

The parameter value configuration. This parameter is required for the production environment. If you specify the same environment multiple times, only the first configuration is used.

object

No

EnvType

string

No

The project environment.

  • Prod: the production environment

  • Dev: the development environment

Prod

Value

string

No

The parameter value.

value123

Owner

string

No

The owner's account ID.

123456789

Description

string

No

The parameter description.

This is a test parameter

Response elements

Element

Type

Description

Example

object

The response data.

Version

integer

The new version number.

2

RequestId

string

The request ID.

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Version": 2,
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.