GetInstance-阿里云帮助中心

Retrieves the details of a FeatureStore instance.

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:GetInstance

get

*All Resource

*

None

Request syntax

GET /api/v1/instances/{InstanceId} 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 this ID.	fs-cn-********

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	1C5B1511-8A5B-59C3-90AF-513F9210E882
Status	string	The status of the instance. Valid values: Initializing: The instance is being initialized. Running: The instance is running. Failure: The instance fails to be created. Stopped: The instance is stopped.	Running
RegionId	string	The region where the instance is deployed.	cn-hangzhou
GmtCreateTime	string	The time when the instance was created. The time is in the ISO 8601 format.	2023-07-04T11:26:09.036+08:00
GmtModifiedTime	string	The time when the instance was last updated. The time is in the ISO 8601 format.	2023-07-04T11:26:09.036+08:00
Progress	number	The progress of instance provisioning.	0.8
Message	string	The message that is returned for the instance provisioning.	Success
Type	string	The type of the instance.	Basic
FeatureDBInstanceInfo `deprecated`	object	The information about the FeatureDB instance.
Status	string	The status of the instance.
FeatureDBInfo	object	The information about the FeatureDB instance.
Status	string	The status of the instance.

Examples

Success response

JSON format

{
  "RequestId": "1C5B1511-8A5B-59C3-90AF-513F9210E882",
  "Status": "Running",
  "RegionId": "cn-hangzhou",
  "GmtCreateTime": "2023-07-04T11:26:09.036+08:00",
  "GmtModifiedTime": "2023-07-04T11:26:09.036+08:00",
  "Progress": 0.8,
  "Message": "Success",
  "Type": "Basic",
  "FeatureDBInstanceInfo": {
    "Status": ""
  },
  "FeatureDBInfo": {
    "Status": ""
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.