文档

ListFeatureConsistencyCheckJobConfigs - 获取特征一致性检查任务配置列表

更新时间:

获取特征一致性检查任务配置列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/featureconsistencycheck/jobconfigs

请求参数

名称类型必填描述示例值
InstanceIdstring

实例 ID。如何获取实例 ID,请参见 ListInstances

pairec-cn-********
PageNumberstring

页码。起始值为 1,默认值为 1。

1
PageSizestring

页大小。

10
SortBystring

排序依据。

  • GmtCreateTime:按创建时间排序。
  • GmtModifiedTime-按更新时间排序。
GmtCreateTime
Orderstring

排序方式。

  • ASC:升序。
  • DESC:降序。
ASC

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

FCF741D8-9C30-578E-807F-B935487DB34A
TotalCountlong

总个数。

10
FeatureConsistencyCheckConfigsobject []

特征一致性检查列表。

FeatureConsistencyCheckJobConfigIdstring

特征一致性检查配置 ID。

3
Namestring

特征一致性检查配置名称。

feature_consistency_check1
SceneIdstring

场景 ID。

3
SceneNamestring

场景名称。

scene1
Statusstring

状态。可能值为:

  • Editable:可编辑的。
  • Uneditable:不可编辑的。
Editable
CompareFeatureboolean

是否开启特征比对。

true
LatestJobIdstring

基于该配置最近一次创建的任务 ID。

3
LatestJobGmtSamplingStartTimestring

最近一次创建的任务的开始时间。

2021-12-15T23:24:33.132+08:00
LatestJobGmtSamplingEndTimestring

最近一次创建的任务的结束时间。

2021-12-15T23:24:33.132+08:00
SampleRatestring

采样比例(0-1)。

0.89
FeatureLandingResourceIdstring

数据回落数据源 ID。

reso-********
FeatureLandingResourceUristring

数据回落数据源地址。

mc_project_1
EasServiceNamestring

EAS 服务名称。

eas_service_1
FgJsonFileNamestring

fg_json 文件名称。

file.json
UserTablestring

user 表名。

user_table
UserIdFieldstring

user_id 字段名。

user_id
UserTablePartitionFieldstring

user 表分区字段。

ds
UserTablePartitionFieldFormatstring

user 表分区字段格式:

  • yyyymmdd
  • yyyy-mm-dd
yyyymmdd
ItemTablestring

item 表名。

item_table
ItemIdFieldstring

item_id 字段名。

item_id
ItemTablePartitionFieldstring

item 表分区字段。

ds
ItemTablePartitionFieldFormatstring

item 表分区字段格式:

  • yyyymmdd
  • yyyy-mm-dd
yyyymmdd
GenerateZipboolean

是否需要生成 zip 包。

true
ServiceIdstring

服务 ID。

4
ServiceNamestring

服务名称。

service1
WorkflowNamestring

工作流名称。

work_flow_1
OssResourceIdstring

OSS 数据源 ID。

reso-********
OssBucketstring

OSS bucket 名称。

oss_bucket_1
EasyRecVersionstring

EasyRec 版本。

1.3.60
EasyRecPackagePathstring

EasyRec 包路径。

oss://*******
FgJarVersionstring

fg_jar 版本。

1.0.0
FeaturePrioritystring

特征优先级,多个特征通过半角逗号(,)分开,表示哪些特征优先从 user 表读取,若 user 表为空,则从行为表查询。

feature1,feature2,feature3
FeatureDisplayExcludestring

特征展示过滤,多个特征通过半角逗号(,)分开。

feature1,feature2
GmtCreateTimestring

创建时间。

2021-12-15T23:24:33.132+08:00
GmtModifiedTimestring

更新时间。

2021-12-15T23:24:33.132+08:00
UseFeatureStorestring

是否使用 feature store,取值:

  • true:使用,此时返回 FeatureStoreProjectId、FeatureStoreProjectName、FeatureStoreModelId、FeatureStoreUserId、FeatureStoreItemId。
  • false:不使用,此时返回 UserTable、UserIdField、UserTablePartitionField、UserTablePartitionFieldFormat、ItemTable、ItemIdField、ItemTablePartitionField、ItemTablePartitionFieldFormat。
true
FeatureStoreProjectNamestring

feature store 项目名称。

project-1
FeatureStoreModelIdstring

feature store model ID。

2
FeatureStoreUserIdstring

feature store user 侧主键。

user
FeatureStoreItemIdstring

feature store item 侧主键。

item
FeatureStoreSeqFeatureViewstring

序列特征中 item 特征所在的特征视图的名字。

item-1
FeatureStoreProjectIdstring

feature store 项目 ID。

prj-01

示例

正常返回示例

JSON格式

{
  "RequestId": "FCF741D8-9C30-578E-807F-B935487DB34A",
  "TotalCount": 10,
  "FeatureConsistencyCheckConfigs": [
    {
      "FeatureConsistencyCheckJobConfigId": "3",
      "Name": "feature_consistency_check1",
      "SceneId": "3",
      "SceneName": "scene1",
      "Status": "Editable",
      "CompareFeature": true,
      "LatestJobId": "3",
      "LatestJobGmtSamplingStartTime": "2021-12-15T23:24:33.132+08:00",
      "LatestJobGmtSamplingEndTime": "2021-12-15T23:24:33.132+08:00",
      "SampleRate": "0.89",
      "FeatureLandingResourceId": "reso-********",
      "FeatureLandingResourceUri": "mc_project_1",
      "EasServiceName": "eas_service_1",
      "FgJsonFileName": "file.json",
      "UserTable": "user_table",
      "UserIdField": "user_id",
      "UserTablePartitionField": "ds",
      "UserTablePartitionFieldFormat": "yyyymmdd",
      "ItemTable": "item_table",
      "ItemIdField": "item_id",
      "ItemTablePartitionField": "ds",
      "ItemTablePartitionFieldFormat": "yyyymmdd",
      "GenerateZip": true,
      "ServiceId": "4",
      "ServiceName": "service1",
      "WorkflowName": "work_flow_1",
      "OssResourceId": "reso-********",
      "OssBucket": "oss_bucket_1",
      "EasyRecVersion": "1.3.60",
      "EasyRecPackagePath": "oss://*******",
      "FgJarVersion": "1.0.0",
      "FeaturePriority": "feature1,feature2,feature3",
      "FeatureDisplayExclude": "feature1,feature2",
      "GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
      "GmtModifiedTime": "2021-12-15T23:24:33.132+08:00",
      "UseFeatureStore": "true",
      "FeatureStoreProjectName": "project-1",
      "FeatureStoreModelId": "2\n",
      "FeatureStoreUserId": "user",
      "FeatureStoreItemId": "item",
      "FeatureStoreSeqFeatureView": "item-1",
      "FeatureStoreProjectId": "prj-01"
    }
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-22OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)