文档

GetFeatureView - 获取特征视图详细信息

更新时间:

获取指定特征视图详细信息。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
featurestore:GetFeatureViewget
  • 全部资源
    *

请求语法

GET /api/v1/instances/{InstanceId}/featureviews/{FeatureViewId}

请求参数

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

实例 ID,可通过接口 ListInstances 获取。

fs-cn-********
FeatureViewIdstring

特征视图 ID,可通过接口 ListFeatureViews 获取。

3

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

72F15A8A-5A28-5B18-A0DE-0EABD7D3245A
ProjectIdstring

项目 ID。

3
ProjectNamestring

项目名称。

project1
FeatureEntityNamestring

特征实体名称。

featureEntity1
Namestring

特征视图名称。

featureView1
Ownerstring

创建人的阿里云账号 ID。

12321421412****
Typestring

类型。

● Batch-离线特征

● Stream-实时特征

Batch
GmtCreateTimestring

创建时间。

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

更新时间。

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

特征实体 ID。

3
JoinIdstring

特征实体的 Join ID。

user_id
WriteMethodstring

写入方式。

● ByReadyMadeTable-使用现成表注册

● Custom-自定义表结构

custom
RegisterTablestring

注册表名称。

table1
RegisterDatasourceIdstring

注册表所在数据源 ID。

4
RegisterDatasourceNamestring

注册表所在数据源名称。

datasource1
WriteToFeatureDBboolean

是否写入在线托管存储。

false
SyncOnlineTableboolean

是否同步在线特征表。

true
TTLinteger

生命周期。

90
Tagsarray

标签列表。

string

特征视图的标签。

tag1
Configstring

配置。

{"save_original_field":true}
GmtSyncTimestring

同步时间。

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

最近一次的同步配置。

{ "mode": "overwrite", "partitions": { "ds": { "value": "20230820" } }, "event_time": "", "config": {}, "offline_to_online": true }
Fieldsarray<object>

字段列表。

object
Namestring

字段名称。

user
Typestring

字段类型。

● int

● string

● float

int
Attributesarray

字段属性列表,可选值包括:

● Partition-分区字段

● PrimaryKey-主键

● EventTime-事件时间

string

字段属性。

Partition
PublishTableScriptstring

同步数据脚本。

from feature_store_py.fs_client import FeatureStoreClient\nimport datetime\nfrom feature_store_py.fs_datasource import MaxComputeDataSource\nimport sys\n\ncur_day = args['dt']\nprint('cur_day = ', cur_day)\n\naccess_key_id = o.account.access_id\naccess_key_secret = o.account.secret_access_key\nfs = FeatureStoreClient(access_key_id=access_key_id, access_key_secret=access_key_secret, region='cn-beijing')\ncur_project_name = 'p1'\nproject = fs.get_project(cur_project_name)\n\nfeature_view_name = 'user_fea'\nbatch_feature_view = project.get_feature_view(feature_view_name)\ntask = batch_feature_view.publish_table(partitions={'ds':cur_day}, mode='Overwrite')\ntask.wait()\ntask.print_summary()\n

示例

正常返回示例

JSON格式

{
  "RequestId": "72F15A8A-5A28-5B18-A0DE-0EABD7D3245A",
  "ProjectId": "3",
  "ProjectName": "project1",
  "FeatureEntityName": "featureEntity1",
  "Name": "featureView1",
  "Owner": "12321421412****",
  "Type": "Batch",
  "GmtCreateTime": "2021-12-15T23:24:33.132+08:00",
  "GmtModifiedTime": "2021-12-15T23:24:33.132+08:00",
  "FeatureEntityId": "3",
  "JoinId": "user_id",
  "WriteMethod": "custom",
  "RegisterTable": "table1",
  "RegisterDatasourceId": "4",
  "RegisterDatasourceName": "datasource1",
  "WriteToFeatureDB": false,
  "SyncOnlineTable": true,
  "TTL": 90,
  "Tags": [
    "tag1"
  ],
  "Config": "{\"save_original_field\":true}",
  "GmtSyncTime": "2021-12-15T23:24:33.132+08:00",
  "LastSyncConfig": "{\n\t\"mode\": \"overwrite\",\n\t\"partitions\": {\n\t\t\"ds\": {\n\t\t\t\"value\": \"20230820\"\n\t\t}\n\t},\n\t\"event_time\": \"\",\n\t\"config\": {},\n\t\"offline_to_online\": true\n}",
  "Fields": [
    {
      "Name": "user",
      "Type": "int",
      "Attributes": [
        "Partition"
      ]
    }
  ],
  "PublishTableScript": "from feature_store_py.fs_client import FeatureStoreClient\\nimport datetime\\nfrom feature_store_py.fs_datasource import MaxComputeDataSource\\nimport sys\\n\\ncur_day = args['dt']\\nprint('cur_day = ', cur_day)\\n\\naccess_key_id = o.account.access_id\\naccess_key_secret = o.account.secret_access_key\\nfs = FeatureStoreClient(access_key_id=access_key_id, access_key_secret=access_key_secret, region='cn-beijing')\\ncur_project_name = 'p1'\\nproject = fs.get_project(cur_project_name)\\n\\nfeature_view_name = 'user_fea'\\nbatch_feature_view = project.get_feature_view(feature_view_name)\\ntask = batch_feature_view.publish_table(partitions={'ds':cur_day}, mode='Overwrite')\\ntask.wait()\\ntask.print_summary()\\n"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-25OpenAPI 返回结构发生变更查看变更详情
2024-01-29OpenAPI 返回结构发生变更查看变更详情