GetParameter-阿里云帮助中心

Gets the details of a parameter by its ID.

Operation description

This operation is available only in DataWorks Professional Edition or 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 ID of the parameter.	12345

Response elements

Element	Type	Description	Example
	object	The response object.
Parameter	object	The details of the parameter.
Id	integer	The ID of the parameter.	12345
Name	string	The name of the parameter.	workspace.para
Type	string	The type of the parameter. Valid values: `PlainConstant`: a constant in plaintext. `SecretConstant`: a constant in ciphertext. `Variable`: a variable.	PlainConstant
Scope	string	The scope of the parameter.	Project
ProjectId	integer	The ID of the workspace.	1000
Version	integer	The version of the parameter.	1
Description	string	The description of the parameter.	This is a test parameter
CreateTime	integer	The time when the parameter was created.	1640000000000
ModifyTime	integer	The time when the parameter was last modified.	1640000000000
Owner	string	The owner of the parameter.	123456789
CreateUser	string	The creator of the parameter.	123456789
ModifyUser	string	The modifier of the parameter.	123456789
Properties	array<object>	The value configurations of the parameter.
	object	A value configuration of the parameter.
EnvType	string	The project environment. Valid values: `Prod`: production. `Dev`: development.	Prod
Value	string	The value of the parameter.	value123
RequestId	string	The request ID.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "Parameter": {
    "Id": 12345,
    "Name": "workspace.para",
    "Type": "PlainConstant",
    "Scope": "Project",
    "ProjectId": 1000,
    "Version": 1,
    "Description": "This is a test parameter",
    "CreateTime": 1640000000000,
    "ModifyTime": 1640000000000,
    "Owner": "123456789",
    "CreateUser": "123456789",
    "ModifyUser": "123456789",
    "Properties": [
      {
        "EnvType": "Prod",
        "Value": "value123"
      }
    ]
  },
  "RequestId": "6A6CBE87-9F91-1323-B680-E7A7065XXXXX"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.