GetModelFeatureFGFeature-阿里云帮助中心

Retrieves the Feature Generation (FG) feature configuration of a model feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

featurestore:GetModelFeatureFGFeature

get

*All Resource

*

None

Request syntax

GET /api/v1/instances/{InstanceId}/modelfeatures/{ModelFeatureId}/fgfeature HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the instance. You can call the ListInstances operation to obtain the ID.	fs-cn-********
ModelFeatureId	string	Yes	The ID of the model feature. You can call the ListModelFeatures operation to obtain the ID.	3

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The ID of the request.	E23EFF09-58AA-5420-934F-8453AE01548D
RawFeatures	array<object>	The information about the raw features.
	object
InputFeatureName	string	The name of the original feature.	item_id
FeatureDomain	string	The domain of the original feature. User: The user side. Item: The item side. Context: The context.	User
FeatureName	string	The name of the generated feature.	item_id
FeatureType	string	The type of the raw FG feature. IdFeature: The primary key. RawFeature: The raw feature.	IdFeature
ValueType	string	The value type of the feature. INTEGER DOUBLE STRING	STRING
DefaultValue	string	The default value.	-1024
LookupFeatures	array<object>	The information about the lookup features.
	object
MapFeatureName	string	The name of the map feature.	item_id
MapFeatureDomain	string	The domain of the map feature. User: The user side. Item: The item side. Context: The context.	User
FeatureName	string	The name of the generated feature.	item_id
ValueType	string	The value type of the feature. INTEGER DOUBLE STRING	STRING
DefaultValue	string	The default value.	-1024
KeyFeatureName	string	The name of the key feature.	1
KeyFeatureDomain	string	The domain of the key feature. User: The user side. Item: The item side. Context: The context.	Item
SequenceFeatures	array<object>	The information about the sequence features.
	array<object>
FeatureName	string	The name of the sequence feature.	item_id
SequenceLength	integer	The maximum length of the sequence feature.	50
SequenceDelim	string	The separator for the sequence feature.	;
AttributeDelim	string	The separator for feature attributes.	#
SubFeatures	array<object>	A list of sub-features for the sequence feature.
	object
InputFeatureName	string	The name of the original feature.	item_id
FeatureDomain	string	The domain of the original feature. User: The user side. Item: The item side. Context: The context.	User
FeatureName	string	The name of the generated feature.	item_id
FeatureType	string	The type of the FG feature. IdFeature: The primary key. RawFeature: The raw feature.	IdFeature
ValueType	string	The value type of the feature. INTEGER DOUBLE STRING	STRING
DefaultValue	string	The default value.	-1024
Reserves	array	The reserved fields.
	string	The name of the reserved field.	f1

Examples

Success response

JSON format

{
  "RequestId": "E23EFF09-58AA-5420-934F-8453AE01548D",
  "RawFeatures": [
    {
      "InputFeatureName": "item_id",
      "FeatureDomain": "User",
      "FeatureName": "item_id",
      "FeatureType": "IdFeature",
      "ValueType": "STRING",
      "DefaultValue": "-1024"
    }
  ],
  "LookupFeatures": [
    {
      "MapFeatureName": "item_id",
      "MapFeatureDomain": "User",
      "FeatureName": "item_id",
      "ValueType": "STRING",
      "DefaultValue": "-1024",
      "KeyFeatureName": "1",
      "KeyFeatureDomain": "Item"
    }
  ],
  "SequenceFeatures": [
    {
      "FeatureName": "item_id",
      "SequenceLength": 50,
      "SequenceDelim": ";",
      "AttributeDelim": "#",
      "SubFeatures": [
        {
          "InputFeatureName": "item_id",
          "FeatureDomain": "User",
          "FeatureName": "item_id",
          "FeatureType": "IdFeature",
          "ValueType": "STRING",
          "DefaultValue": "-1024"
        }
      ]
    }
  ],
  "Reserves": [
    "f1"
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.