查詢參數列表。
介面說明
需要購買 DataWorks 專業版及以上版本才能使用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ProjectId |
integer |
否 |
工作空間的 ID。您可以通過 ListProjects 介面擷取工作空間 ID。 |
1000 |
| Scope |
string |
否 |
參數使用範圍。預設 Project,暫不可選擇其他類型。 |
Project |
| Type |
string |
否 |
類型。
|
PlainConstant |
| Ids |
array |
否 |
參數 ID 列表。 |
|
|
integer |
否 |
參數 ID。 |
123 |
|
| Names |
array |
否 |
參數名列表。 |
|
|
string |
否 |
參數名。 |
workspace.para |
|
| Owner |
string |
否 |
責任人的帳號 ID。 |
123456789 |
| SortBy |
string |
否 |
排序欄位列表,支援修改時間、建立時間等欄位,格式為"排序欄位+排序方式(Desc/Asc)"(Asc 可以預設)。排序欄位的枚舉值如下:
|
ModifyTime Desc |
| PageSize |
integer |
否 |
每頁顯示的條數,預設為 20 條。 |
20 |
| PageNumber |
integer |
否 |
頁碼數,預設為 1。 |
1 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| PagingInfo |
object |
返回資料 |
|
| TotalCount |
integer |
總數 |
100 |
| PageSize |
integer |
每頁顯示的條數。 |
10 |
| PageNumber |
integer |
頁碼數。 |
1 |
| Parameters |
array<object> |
參數列表 |
|
|
array<object> |
參數資訊 |
||
| Id |
integer |
參數 ID |
12345 |
| Name |
string |
參數名稱 |
workspace.para |
| Type |
string |
類型。
|
PlainConstant |
| Scope |
string |
參數範圍 |
Project |
| ProjectId |
integer |
工作空間 ID |
1000 |
| Version |
integer |
版本號碼 |
1 |
| Description |
string |
描述資訊 |
這是一個測試參數 |
| CreateTime |
integer |
建立時間 |
1640000000000 |
| ModifyTime |
integer |
修改時間 |
1640000000000 |
| Owner |
string |
責任人 |
123456789 |
| CreateUser |
string |
建立人 |
123456789 |
| ModifyUser |
string |
修改人 |
123456789 |
| Properties |
array<object> |
參數值配置 |
|
|
object |
參數值配置項 |
||
| EnvType |
string |
專案環境。
|
Prod |
| Value |
string |
參數值 |
value123 |
| RequestId |
string |
請求 ID |
6A6CBE87-9F91-1323-B680-E7A7065XXXXX |
樣本
正常返回樣本
JSON格式
{
"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"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。