Consulta a lista de parâmetros de consulta.
Descrição da operação
É necessário o DataWorks Professional Edition ou superior.
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
POST HTTP/1.1Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ProjectId |
integer |
Não |
O ID do workspace. Você pode chamar a operação ListProjects para obter o ID do workspace. |
1000 |
| Scope |
string |
Não |
O escopo do parâmetro. Valor padrão: Project. Outros tipos não são suportados. Valores válidos:
|
Project |
| Type |
string |
Não |
O tipo de parâmetro. Valores válidos:
Valores válidos:
|
PlainConstant |
| Ids |
array |
Não |
A lista de IDs de parâmetros. |
|
|
integer |
Não |
O ID do parâmetro. |
123 |
|
| Names |
array |
Não |
A lista de nomes de parâmetros. |
|
|
string |
Não |
O nome do parâmetro. |
workspace.para |
|
| Owner |
string |
Não |
O ID da conta do proprietário. |
123456789 |
| SortBy |
string |
Não |
A lista de campos pelos quais ordenar os resultados. Os campos suportados incluem hora de modificação e hora de criação. O formato é "SortField+SortOrder(Desc/Asc)". Você pode omitir Asc. Valores válidos:
|
ModifyTime Desc |
| PageSize |
integer |
Não |
O número de entradas a serem retornadas em cada página. Valor padrão: 20. |
20 |
| PageNumber |
integer |
Não |
O número da página. Valor padrão: 1. |
1 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Esquema da resposta. |
||
| PagingInfo |
object |
Os dados da resposta. |
|
| TotalCount |
integer |
O número total de entradas. |
100 |
| PageSize |
integer |
O número de entradas retornadas por página. |
10 |
| PageNumber |
integer |
O número da página. |
1 |
| Parameters |
array<object> |
A lista de parâmetros. |
|
|
array<object> |
As informações do parâmetro. |
||
| Id |
integer |
O ID do parâmetro. |
12345 |
| Name |
string |
O nome do parâmetro. |
workspace.para |
| Type |
string |
O tipo de parâmetro. Valores válidos:
|
PlainConstant |
| Scope |
string |
O escopo do parâmetro. |
Project |
| ProjectId |
integer |
O ID do workspace. |
1000 |
| Version |
integer |
O número da versão. |
1 |
| Description |
string |
A descrição. |
This is a test parameter |
| CreateTime |
integer |
A hora de criação. O valor é um número de 13 dígitos, como |
1640000000000 |
| ModifyTime |
integer |
A hora de modificação. O valor é um número de 13 dígitos, como |
1640000000000 |
| Owner |
string |
O proprietário. |
123456789 |
| CreateUser |
string |
O usuário que criou o parâmetro. |
123456789 |
| ModifyUser |
string |
O usuário que modificou o parâmetro pela última vez. |
123456789 |
| Properties |
array<object> |
A configuração do valor do parâmetro. |
|
|
object |
O item de configuração do valor do parâmetro. |
||
| EnvType |
string |
O ambiente do projeto. Valores válidos:
|
Prod |
| Value |
string |
O valor do parâmetro. |
value123 |
| RequestId |
string |
O ID da solicitação. |
6A6CBE87-9F91-1323-B680-E7A7065XXXXX |
Exemplos
Resposta de sucesso
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 erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.