All Products
Search

This Product

    DataWorks:CreateParameter

    Document Center

    DataWorks:CreateParameter

    Last Updated:Apr 20, 2026

    Creates a parameter.

    Operation description

    This operation requires DataWorks Professional Edition or a later edition.

    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

    Name

    string

    Yes

    The parameter name. It must be unique within the workspace, be prefixed with workspace., and not exceed 255 characters. The part of the name after the prefix must start with a letter and can contain only letters, digits, and underscores (_).

    workspace.para

    Properties

    array<object>

    Yes

    The value configurations for the parameter. A configuration for the production environment is required. If you provide duplicate configurations for an environment, only the first one is used.

    object

    No

    EnvType

    string

    No

    The environment.

    • Prod: production environment

    • Dev: development environment

    Prod

    Value

    string

    No

    The value of the parameter. The value can contain Chinese characters, letters, digits, and the following special characters: /, :, ., [, ], ,, \, ', ", _, =, ?, space, carriage return, line feed, +, -, *, %, &, @, !, $, #, {, and }.

    value123

    Type

    string

    Yes

    The type of the parameter.

    • PlainConstant: plaintext constant.

    • SecretConstant: secret constant.

    • Variable: variable.

    PlainConstant

    ProjectId

    integer

    Yes

    The workspace ID. This parameter is required when Scope is set to Project.

    1000

    Owner

    string

    Yes

    The account ID of the owner.

    123456789

    Description

    string

    No

    The description of the parameter.

    This is a test parameter

    Scope

    string

    No

    The scope of the parameter. The default value is Project. No other values are currently supported.

    Project

    Response elements

    Element

    Type

    Description

    Example

    object

    Response schema

    Id

    integer

    The parameter ID.

    123

    RequestId

    string

    The request ID.

    6A6CBE87-9F91-1323-B680-E7A7065XXXXX

    Examples

    Success response

    JSON format

    {
  "Id": 123,
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.