ListParameterVersions

更新时间:
复制 MD 格式

Lists parameter versions.

Operation description

This feature is available in DataWorks Professional Edition and higher editions.

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

SortBy

string

No

Specifies the sort criterion in the format <sort field> <sort order>. You can omit Asc for ascending order. The only valid value for the sort field is:

  • Version (Desc/Asc)

Version Desc

PageSize

integer

No

Specifies the number of entries to return per page. Default value: 20.

20

PageNumber

integer

No

Specifies the page number of the results to return. Default value: 1.

1

Response elements

Element

Type

Description

Example

object

The data returned by the API.

PagingInfo

object

The pagination information.

TotalCount

integer

The total count.

10

PageSize

integer

The number of entries per page.

20

PageNumber

integer

The page number.

1

ParameterVersion

array<object>

The list of parameter versions.

array<object>

The details of a parameter version.

Id

integer

The parameter ID.

12345

Name

string

The parameter name.

workspace.para

Type

string

The type of the parameter. Valid values:

  • PlainConstant: a plaintext constant.

  • SecretConstant: a secret constant.

  • Variable: a variable.

PlainConstant

Scope

string

The scope of the parameter.

Project

ProjectId

integer

The workspace ID.

1000

Version

integer

The version number.

1

Description

string

The parameter description.

这是一个测试参数

CreateTime

integer

The creation time.

1640000000000

ModifyTime

integer

The modification time.

1640000000000

Owner

string

The ID of the owner.

123456789

CreateUser

string

The ID of the creator.

123456789

ModifyUser

string

The ID of the modifier.

123456789

Properties

array<object>

The environment-specific configurations of the parameter value.

object

A configuration of 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": 10,
    "PageSize": 20,
    "PageNumber": 1,
    "ParameterVersion": [
      {
        "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.