ListParameters-阿里云帮助中心

Query parameters.

Operation description

This feature is available in DataWorks Professional Edition or higher.

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
ProjectId	integer	No	The workspace ID. Call the ListProjects operation to get the workspace ID.	1000
Scope	string	No	The scope of the parameter. The default value is Project. Other values are not supported.	Project
Type	string	No	The type of the parameter. Valid values: PlainConstant: A plaintext constant. SecretConstant: A secret constant. Variable: A variable.	PlainConstant
Ids	array	No	A list of parameter IDs.
	integer	No	The parameter ID.	123
Names	array	No	A list of parameter names.
	string	No	The parameter name.	workspace.para
Owner	string	No	The account ID of the owner.	123456789
SortBy	string	No	The field to sort the parameters by. Specify the value in the "FieldName SortOrder" format. The Asc sort order is optional. Supported values are: ModifyTime (Desc/Asc) CreateTime (Desc/Asc) Name (Desc/Asc)	ModifyTime Desc
PageSize	integer	No	The number of entries per page. Default: 20.	20
PageNumber	integer	No	The page number. Default: 1.	1

Response elements

Element	Type	Description	Example
	object	The response data.
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of parameters.	100
PageSize	integer	The number of entries per page.	10
PageNumber	integer	The page number.	1
Parameters	array<object>	A list of parameters.
	array<object>	The details of a parameter.
Id	integer	The parameter ID.	12345
Name	string	The parameter name.	workspace.para
Type	string	The parameter type. Valid values: `PlainConstant`: a plaintext constant `SecretConstant`: an encrypted constant `Variable`: a variable	PlainConstant
Scope	string	The parameter scope.	Project
ProjectId	integer	The workspace ID.	1000
Version	integer	The version number.	1
Description	string	The parameter description.	这是一个测试参数
CreateTime	integer	The time when the parameter was created. This value is a UNIX timestamp in milliseconds.	1640000000000
ModifyTime	integer	The time when the parameter was last modified. This value is a UNIX timestamp in milliseconds.	1640000000000
Owner	string	The Alibaba Cloud account ID of the owner.	123456789
CreateUser	string	The Alibaba Cloud account ID of the creator.	123456789
ModifyUser	string	The Alibaba Cloud account ID of the user who last modified the parameter.	123456789
Properties	array<object>	The environment-specific values for the parameter.
	object	An object that contains the parameter value for a specific environment.
EnvType	string	The environment type. Valid values: `Prod`: production environment `Dev`: development environment	Prod
Value	string	The parameter value.	value123
RequestId	string	The request ID.	6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Examples

Success response

JSON format

{
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "Parameters": [
      {
        "Id": 12345,
        "Name": "workspace.para",
        "Type": "PlainConstant",
        "Scope": "Project",
        "ProjectId": 1000,
        "Version": 1,
        "Description": "这是一个测试参数",
        "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.