Searching for a Service Filter
Function
Search for filter information by name, description, creator, reviewer, filter group ID, modification time, and status.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/design/conditions
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
name |
No |
String |
Fuzzy query by name or code. |
|
create_by |
No |
String |
Query by creator. |
|
approver |
No |
String |
Query by reviewer. |
|
status |
No |
String |
Specifies the service status. Options:
|
|
begin_time |
No |
String |
Left boundary of time filtering. This parameter is used together with end_time. Only time range filtering is supported. Unilateral filtering is invalid. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
|
end_time |
No |
String |
Right boundary for time filtering. This parameter is used together with begin_time to support only time range filtering. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
|
limit |
No |
Integer |
Number of records to be queried on each page, that is, Y records to be queried. The default value is 50, and the value range is [1,100]. |
|
offset |
No |
Integer |
Start coordinate of the query, that is, the number of skipped data records. The value can only be 0 or an integer multiple of limit. If the value does not meet the requirement, the value is rounded down. The default value is 0. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
IAM token, which is obtained by calling the IAM API for obtaining a user token (value of X-Subject-Token in the response header). This field is mandatory for authentication using tokens. |
|
workspace |
Yes |
String |
Workspace ID. For details about how to obtain the workspace ID, see Instance ID and Workspace ID. |
|
X-Project-Id |
No |
String |
Project ID. For details about how to obtain the project ID, see Project ID and Account ID. This parameter is mandatory for API requests that use AK/SK authentication in multi-project scenarios. |
|
Content-Type |
No |
String |
Default value: application/json;charset=UTF-8 This parameter is optional. If the body is available, this parameter is mandatory. If the body is unavailable, you do not need to set this parameter or verify it. |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
data |
data object |
data: unified outermost data structure of the returned result. |
|
Parameter |
Type |
Description |
|---|---|---|
|
value |
value object |
value: unified outer data structure of the returned result. |
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total number. |
|
records |
Array of ConditionVO objects |
ConditionVO information. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
ID, which is a string |
|
name_en |
String |
Parameter |
|
name_ch |
String |
Service attribute. |
|
description |
String |
Description. |
|
create_by |
String |
Creator. |
|
condition_fn |
String |
Limit the calculation method. Options:
|
|
condition_fn_param |
String |
Limit calculation parameters. |
|
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
|
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
|
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
|
approval_info |
ApprovalVO object |
Approval information. This parameter is read-only. Latest review information about a business object, including the business details, reviewer information, and review time. |
|
new_biz |
BizVersionManageVO object |
Service version management. This parameter is read-only. |
|
base_time |
Integer |
Indicates the reference time. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Application ID, which is a string |
|
tenant_id |
String |
Project ID. For details about how to obtain the project ID, see the API path parameter project_id. |
|
name_ch |
String |
Chinese name of a service. |
|
name_en |
String |
English name of a service. |
|
biz_id |
String |
Business ID, which is a string |
|
biz_type |
String |
Business entity type. Options:
|
|
biz_info |
String |
Serialized service details. The type is string. |
|
biz_info_obj |
Object |
Service details. The type is object. |
|
biz_version |
Integer |
Service version. |
|
biz_status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
|
approval_status |
String |
Service approval status. This parameter is read-only. Options:
|
|
approval_type |
String |
Service review type. Options:
|
|
submit_time |
String |
Submitted At |
|
create_by |
String |
Creator. |
|
l1 |
String |
Chinese name of the subject area group. This parameter is read-only and does not need to be set when you create or update a subject area group. |
|
l2 |
String |
Chinese name of the subject area. This parameter is read-only and does not need to be set during creation and update. |
|
l3 |
String |
Chinese name of the business object. This parameter is read-only and does not need to be set during creation and update. |
|
approval_time |
String |
Review time. |
|
approver |
String |
Reviewer. |
|
|
String |
Email address of the reviewer. |
|
msg |
String |
Review information. |
|
directory_path |
String |
Directory tree. |
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
String |
Field ID, which is a string |
|
biz_type |
String |
Business entity type. Options:
|
|
biz_id |
String |
Business ID, which is a string |
|
biz_info |
String |
Business object information. |
|
status |
String |
Release status of an entity. This parameter is read-only and does not need to be set during creation and update. Options:
|
|
biz_version |
Integer |
Service version, which is read-only. |
|
create_time |
String |
Creation time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
|
update_time |
String |
Update time, which is read-only. The format complies with RFC3339 and is accurate to seconds. The UTC time zone is yyyy-mm-ddTHH:MM:SSZ, for example, 1970-01-01T00:00:00Z. |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data information. |
Status code: 401
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data information. |
Status code: 403
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error code, for example, DS.6000, indicating that the request fails to be processed. |
|
error_msg |
String |
Error message |
|
data |
Object |
Returned data information. |
Example Requests
Search for the time filter information.
GET https://{endpoint}/v2/{project_id}/design/conditions?condition_type=TIME_CONDITION
Example Responses
Status code: 200
This operation succeeds, and the returned data is a ConditionVO array and the total number of records.
{
"data" : {
"value" : {
"total" : 29,
"records" : [ {
"id" : "1204396387974955008",
"name_en" : "last_month",
"name_ch" : "Previous month",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_MONTH",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2024-02-06T12:01:15+08:00",
"update_time" : "2024-03-07T18:01:43+08:00",
"approval_info" : {
"id" : "1215358735950708736",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1204396387974955008",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2024-03-07T18:01:43+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2024-03-07T18:01:43+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK.",
"directory_path" : null
},
"new_biz" : null,
"base_time" : 1
}, {
"id" : "1167067126117302272",
"name_en" : "t003",
"name_ch" : "t003",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-10-26T11:48:06+08:00",
"update_time" : "2023-11-09T13:36:28+08:00",
"approval_info" : {
"id" : "1172167829596860416",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1167067126117302272",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-11-09T13:36:28+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-11-09T13:36:28+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK. (Associated Publish By t003, Automatic Approval.)",
"directory_path" : null
},
"new_biz" : null,
"base_time" : null
}, {
"id" : "1163941657377488896",
"name_en" : "t002",
"name_ch" : "t002",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-10-17T20:48:36+08:00",
"update_time" : "2023-10-18T13:57:14+08:00",
"approval_info" : {
"id" : "1163941893843959808",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1163941657377488896",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-10-17T20:49:32+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-10-17T21:20:02+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "1",
"directory_path" : null
},
"new_biz" : {
"id" : null,
"biz_type" : "TIME_CONDITION",
"biz_id" : "1163941657377488896",
"biz_info" : "{\"versionName\":null,\"versionTag\":null,\"versionId\":null,\"createBy\":\"0833a573fe80d5401f6dc010a775569a\",\"updateBy\":\"0833a573fe80d5401f6dc010a775569a\",\"createTime\":1697546916000,\"updateTime\":1698292074309,\"l3Id\":null,\"l2Id\":null,\"alias\":null,\"encoding\":null,\"prefix\":null,\"codeNum\":null,\"id\":\"1163941657377488896\",\"tenantId\":\"0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70\",\"nameCh\":\"t002\",\"nameEn\":\"t002\",\"description\":\"\",\"conditionFn\":\"LAST_YEAR\",\"calExp\":null,\"conditionFnParam\":\"0\",\"status\":\"PUBLISHED\",\"enableFlag\":true,\"nameTranslate\":null,\"descriptionTranslate\":null,\"baseTime\":null,\"lastL2Id\":null}",
"status" : "DRAFT",
"biz_version" : 0,
"create_time" : "2023-10-26T11:47:54+08:00",
"update_time" : "2023-10-26T11:47:54+08:00"
},
"base_time" : null
}, {
"id" : "1163941632085835776",
"name_en" : "t001",
"name_ch" : "t001",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "OFFLINE",
"create_time" : "2023-10-17T20:48:30+08:00",
"update_time" : "2023-10-24T20:15:22+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1163884268984922112",
"name_en" : "sj1017",
"name_ch" : "sj1017",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-10-17T17:00:34+08:00",
"update_time" : "2023-10-30T16:37:42+08:00",
"approval_info" : {
"id" : "1163926109700734976",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1163884268984922112",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-10-17T19:46:49+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-10-17T19:50:00+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "ok",
"directory_path" : null
},
"new_biz" : null,
"base_time" : null
}, {
"id" : "1155167466507448320",
"name_en" : "lix",
"name_ch" : "lix",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_MONTH",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-09-23T15:43:06+08:00",
"update_time" : "2023-10-17T20:46:11+08:00",
"approval_info" : {
"id" : "1155919632490725376",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1155167466507448320",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-09-25T17:31:56+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-09-25T17:31:56+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK. (Associated Publish By lix, Automatic Approval.)",
"directory_path" : null
},
"new_biz" : {
"id" : null,
"biz_type" : "TIME_CONDITION",
"biz_id" : "1155167466507448320",
"biz_info" : "{\"versionName\":null,\"versionTag\":null,\"versionId\":null,\"createBy\":\"0833a573fe80d5401f6dc010a775569a\",\"updateBy\":\"0833a573fe80d5401f6dc010a775569a\",\"createTime\":1695454986000,\"updateTime\":1698149390708,\"l3Id\":null,\"l2Id\":null,\"alias\":null,\"encoding\":null,\"prefix\":null,\"codeNum\":null,\"id\":\"1155167466507448320\",\"tenantId\":\"0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70\",\"nameCh\":\"lix\",\"nameEn\":\"lix\",\"description\":\"\",\"conditionFn\":\"LAST_MONTH\",\"calExp\":null,\"conditionFnParam\":\"0\",\"status\":\"PUBLISHED\",\"enableFlag\":true,\"nameTranslate\":null,\"descriptionTranslate\":null,\"baseTime\":2,\"lastL2Id\":null}",
"status" : "DRAFT",
"biz_version" : 0,
"create_time" : "2023-10-24T20:09:51+08:00",
"update_time" : "2023-10-24T20:09:51+08:00"
},
"base_time" : 2
}, {
"id" : "1154507394794024960",
"name_en" : "oi11",
"name_ch" : "oi11",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-09-21T20:00:13+08:00",
"update_time" : "2023-10-17T16:54:20+08:00",
"approval_info" : {
"id" : "1163882705348386816",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1154507394794024960",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-10-17T16:54:21+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-10-17T16:54:20+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK.",
"directory_path" : null
},
"new_biz" : null,
"base_time" : null
}, {
"id" : "1154507340083523584",
"name_en" : "lxy0101",
"name_ch" : "lxy0101",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-09-21T20:00:00+08:00",
"update_time" : "2023-10-30T16:37:06+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1150823722467344384",
"name_en" : "current_month",
"name_ch" : "Current Month",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "CURRENT_MONTH",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-09-11T16:02:37+08:00",
"update_time" : "2023-09-11T16:02:37+08:00",
"approval_info" : {
"id" : "1150823723427840000",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1150823722467344384",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-09-11T16:02:37+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-09-11T16:02:37+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK.",
"directory_path" : null
},
"new_biz" : null,
"base_time" : 1
}, {
"id" : "1128840997309136896",
"name_en" : "aa",
"name_ch" : "a",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-1,1",
"status" : "REJECT",
"create_time" : "2023-07-13T00:11:07+08:00",
"update_time" : "2024-02-27T21:44:53+08:00",
"approval_info" : {
"id" : "1200506282973483008",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1128840997309136896",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "REJECT",
"approval_status" : "REJECT",
"approval_type" : null,
"submit_time" : "2024-01-26T18:23:22+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2024-02-27T21:44:53+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "no",
"directory_path" : null
},
"new_biz" : null,
"base_time" : 1
}, {
"id" : "1128832688892035072",
"name_en" : "last_year",
"name_ch" : "One Year Before",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "PUBLISHED",
"create_time" : "2023-07-12T23:38:06+08:00",
"update_time" : "2023-07-12T23:38:11+08:00",
"approval_info" : {
"id" : "1128832714003333120",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1128832688892035072",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-07-12T23:38:12+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-07-12T23:38:11+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK.",
"directory_path" : null
},
"new_biz" : null,
"base_time" : null
}, {
"id" : "1128831725523312640",
"name_en" : "bbbbb",
"name_ch" : "bbb",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "LAST_YEAR",
"condition_fn_param" : "0",
"status" : "DRAFT",
"create_time" : "2023-07-12T23:34:16+08:00",
"update_time" : "2023-07-12T23:34:16+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1128831552864788480",
"name_en" : "aaa",
"name_ch" : "aaa",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "CURRENT_YEAR",
"condition_fn_param" : "0",
"status" : "DRAFT",
"create_time" : "2023-07-12T23:33:35+08:00",
"update_time" : "2023-07-12T23:34:33+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1109414797142806528",
"name_en" : "1m_year_on_year",
"name_ch" : "Last 30 Days_Same Period Last Year",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-395,-365",
"status" : "PUBLISHED",
"create_time" : "2023-05-20T09:38:20+08:00",
"update_time" : "2023-05-20T09:38:19+08:00",
"approval_info" : {
"id" : "1109414797620957184",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1109414797142806528",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-05-20T09:38:20+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-05-20T09:38:19+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK.",
"directory_path" : null
},
"new_biz" : {
"id" : null,
"biz_type" : "TIME_CONDITION",
"biz_id" : "1109414797142806528",
"biz_info" : "{\"versionName\":null,\"versionTag\":null,\"versionId\":null,\"createBy\":\"0833a573fe80d5401f6dc010a775569a\",\"updateBy\":null,\"createTime\":1684546700000,\"updateTime\":1684546699000,\"l3Id\":null,\"l2Id\":null,\"alias\":null,\"encoding\":null,\"prefix\":null,\"codeNum\":null,\"id\":\"1109414797142806528\",\"tenantId\":\"0833a5737480d53b2f25c010dc1a7b88-workspace-eeb055e69c624311b6b9cfee89a4ec70\",\"nameCh\": \"in the Last 30 Days_ \",\"nameEn\":\"1m_year_on_year\",\"description\":\"\",\"conditionFn\":\"BETWEEN_DAY\",\"calExp\":null,\"conditionFnParam\":\"-395,-365\",\"status\":\"PUBLISHED\",\"enableFlag\":true,\"nameTranslate\":null,\"descriptionTranslate\":null,\"baseTime\":null,\"lastL2Id\":null} in the Same Period Last Year",
"status" : "DRAFT",
"biz_version" : 0,
"create_time" : "2023-06-01T14:17:10+08:00",
"update_time" : "2023-06-01T14:17:10+08:00"
},
"base_time" : null
}, {
"id" : "1109414655866064896",
"name_en" : "1m_prior_period",
"name_ch" : "Last 30 Days_Previous Period",
"description" : "",
"create_by" : "test_uesr",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-60,-30",
"status" : "PUBLISHED",
"create_time" : "2023-05-20T09:37:46+08:00",
"update_time" : "2023-05-20T09:37:46+08:00",
"approval_info" : {
"id" : "1109414656310661120",
"tenant_id" : null,
"name_ch" : null,
"name_en" : null,
"biz_id" : "1109414655866064896",
"biz_type" : null,
"biz_info" : null,
"biz_info_obj" : null,
"biz_version" : 0,
"biz_status" : "PUBLISHED",
"approval_status" : "APPROVED",
"approval_type" : null,
"submit_time" : "2023-05-20T09:37:46+08:00",
"create_by" : null,
"l1" : null,
"l2" : null,
"l3" : null,
"approval_time" : "2023-05-20T09:37:46+08:00",
"approver" : "test_uesr",
"email" : null,
"msg" : "Fast Approval OK.",
"directory_path" : null
},
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812749",
"name_en" : "f4w",
"name_ch" : "Next 4 weeks",
"description" : "Daily average value of historical data x 7 x 4",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "1,28",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812748",
"name_en" : "f1w",
"name_ch" : "Next 7 days",
"description" : "Daily average value of historical data x 7",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "1,7",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812747",
"name_en" : "1h",
"name_ch" : "Last 1 hour.",
"description" : "Data of the Last Hour",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_HOUR",
"condition_fn_param" : "-1,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812746",
"name_en" : "td",
"name_ch" : "By the current day",
"description" : "All data (in the last 10 years) by the calculation date (included)",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-3650,0",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812745",
"name_en" : "b30d",
"name_ch" : "One day 30 days ago",
"description" : "Data of the 31st day before",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-31,-30",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812744",
"name_en" : "bh",
"name_ch" : "All 180 days ago",
"description" : "All data (in the last 10 years) by 180 days ago (the 181st day before), before half-year",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-3650,-181",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812743",
"name_en" : "6m",
"name_ch" : "Last 180 days",
"description" : "Data of 180 Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-180,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812742",
"name_en" : "3m",
"name_ch" : "Last 90 days",
"description" : "Data of 90 Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-90,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812741",
"name_en" : "2m",
"name_ch" : "Last 60 days",
"description" : "Data of 60 Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-60,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812740",
"name_en" : "1m",
"name_ch" : "Latest 30 days",
"description" : "Data of 30 Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-30,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812739",
"name_en" : "2w",
"name_ch" : "Last 14 days",
"description" : "Data of 14 Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-14,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812738",
"name_en" : "1w",
"name_ch" : "Last 7 days",
"description" : "Data of Seven Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-7,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812737",
"name_en" : "3d",
"name_ch" : "Last 3 days",
"description" : "Data of Three Days Up to Yesterday",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-3,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
}, {
"id" : "1013133487357812736",
"name_en" : "1d",
"name_ch" : "Last 24 hours",
"description" : "Yesterday's value",
"create_by" : "SYSTEM",
"condition_fn" : "BETWEEN_DAY",
"condition_fn_param" : "-1,-1",
"status" : "PUBLISHED",
"create_time" : "2022-08-27T17:10:46+08:00",
"update_time" : "2022-08-27T17:10:46+08:00",
"approval_info" : null,
"new_biz" : null,
"base_time" : null
} ]
}
}
}
Status code: 400
{
"error_code" : "DS.60xx",
"error_msg" : "The user request is illegal."
}
Status code: 401
{
"error_code" : "DS.60xx",
"error_msg" : "User authentication failed."
}
Status code: 403
{
"error_code" : "DS.60xx",
"error_msg" : "The user does not have permission to call this API."
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dataartsstudio.v1.region.DataArtsStudioRegion; import com.huaweicloud.sdk.dataartsstudio.v1.*; import com.huaweicloud.sdk.dataartsstudio.v1.model.*; public class ListConditionSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DataArtsStudioClient client = DataArtsStudioClient.newBuilder() .withCredential(auth) .withRegion(DataArtsStudioRegion.valueOf("<YOUR REGION>")) .build(); ListConditionRequest request = new ListConditionRequest(); try { ListConditionResponse response = client.listCondition(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdataartsstudio.v1.region.dataartsstudio_region import DataArtsStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdataartsstudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DataArtsStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(DataArtsStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListConditionRequest() response = client.list_condition(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dataartsstudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dataartsstudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dataartsstudio.NewDataArtsStudioClient( dataartsstudio.DataArtsStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListConditionRequest{} response, err := client.ListCondition(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
This operation succeeds, and the returned data is a ConditionVO array and the total number of records. |
|
400 |
BadRequest |
|
401 |
Unauthorized |
|
403 |
Forbidden |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
