Todos los productos
Search
Centro de documentos

DataWorks:ListParameters

Última actualización: Oct 09, 2026

Consulta la lista de parámetros de consulta.

Descripción de la operación

Se requiere DataWorks Professional Edition o una versión posterior.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

No se requiere autorización para esta operación. Si experimenta problemas al ejecutarla, póngase en contacto con el soporte técnico.

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

ProjectId

integer

No

El ID del espacio de trabajo. Puede llamar a la operación ListProjects para obtener el ID del espacio de trabajo.

1000

Scope

string

No

El alcance del parámetro. Valor predeterminado: Project. No se admiten otros tipos.

Valores válidos:

  • Project :

    Project.

Project

Type

string

No

El tipo de parámetro. Valores válidos:

  • PlainConstant: constante de texto sin cifrar.

  • SecretConstant: constante de texto cifrado.

  • Variable: variable.

Valores válidos:

  • Variable :

    Variable.

  • SecretConstant :

    Constante de texto cifrado.

  • PlainConstant :

    Constante de texto sin cifrar.

PlainConstant

Ids

array

No

La lista de ID de parámetros.

integer

No

El ID del parámetro.

123

Names

array

No

La lista de nombres de parámetros.

string

No

El nombre del parámetro.

workspace.para

Owner

string

No

El ID de cuenta del propietario.

123456789

SortBy

string

No

La lista de campos por los cuales ordenar los resultados. Los campos admitidos incluyen la hora de modificación y la hora de creación. El formato es "SortField+SortOrder(Desc/Asc)". Puede omitir Asc. Valores válidos:

  • ModifyTime (Desc/Asc)

  • CreateTime (Desc/Asc)

  • Name (Desc/Asc)

ModifyTime Desc

PageSize

integer

No

El número de entradas que se devolverán en cada página. Valor predeterminado: 20.

20

PageNumber

integer

No

El número de página. Valor predeterminado: 1.

1

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

Esquema de la respuesta.

PagingInfo

object

Los datos de respuesta.

TotalCount

integer

El número total de entradas.

100

PageSize

integer

El número de entradas devueltas por página.

10

PageNumber

integer

El número de página.

1

Parameters

array<object>

La lista de parámetros.

array<object>

La información del parámetro.

Id

integer

El ID del parámetro.

12345

Name

string

El nombre del parámetro.

workspace.para

Type

string

El tipo de parámetro. Valores válidos:

  • PlainConstant: constante de texto sin cifrar.

  • SecretConstant: constante de texto cifrado.

  • Variable: variable.

PlainConstant

Scope

string

El alcance del parámetro.

Project

ProjectId

integer

El ID del espacio de trabajo.

1000

Version

integer

El número de versión.

1

Description

string

La descripción.

This is a test parameter

CreateTime

integer

La hora de creación.

El valor es un número de 13 dígitos, como 1640000000000.

1640000000000

ModifyTime

integer

La hora de modificación.

El valor es un número de 13 dígitos, como 1640000000000.

1640000000000

Owner

string

El propietario.

123456789

CreateUser

string

El usuario que creó el parámetro.

123456789

ModifyUser

string

El usuario que modificó el parámetro por última vez.

123456789

Properties

array<object>

La configuración del valor del parámetro.

object

El elemento de configuración del valor del parámetro.

EnvType

string

El entorno del proyecto. Valores válidos:

  • Prod: entorno de producción.

  • Dev: entorno de desarrollo.

Prod

Value

string

El valor del parámetro.

value123

RequestId

string

El ID de la solicitud.

6A6CBE87-9F91-1323-B680-E7A7065XXXXX

Ejemplos

Respuesta exitosa

JSON Formato

{
  "PagingInfo": {
    "TotalCount": 100,
    "PageSize": 10,
    "PageNumber": 1,
    "Parameters": [
      {
        "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"
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.