Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Instance Management/ Querying the Instance List

Updated on 2024-02-21 GMT+08:00

View PDF

Querying the Instance List

Function

This API is used to query a list of instances created by a user.

URI

GET /v1/{project_id}/instances

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For how to obtain the project ID, see Obtaining a Project ID (lakeformation_04_0026.xml).

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
in_recycle_bin	Yes	Boolean	Whether to query instances in the recycle bin. The default value is false.
status	No	String	Instance status. RESOURCE_PREPARATION indicates that the instance is being prepared. RUNNING indicates that the instance is running. RESOURCE_RELEASE indicates that the instance is being released. DELETED indicates that the instance has been released, RESOURCE_PREPARATION_FAIL indicates that the instance preparation fails. FROZEN_RELEASABLE indicates that the instance can be restored. FROZEN_UNRELEASABLE indicates that the instance cannot be restored. RECOVERING, DELETING, and SCALING indicates that the instance is being restored, deleted, and scaled, respectively. SCALE_FAIL indicates the scaling of the instance fails. Enumeration values: RESOURCE_PREPARATION RUNNING RESOURCE_RELEASE DELETED RESOURCE_PREPARATION_FAIL FROZEN_RELEASABLE FROZEN_UNRELEASABLE RECOVERING DELETING SCALING SCALE_FAIL
offset	Yes	Integer	Offset of the page-based query. The default value is 0. The value ranges from 0 to 1000.
limit	Yes	Integer	Number of records displayed on one page. The default value is 10. The value ranges from 1 to 1000.
name	No	String	This API is used to search information using LakeFormation instance name. The value should contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed.
enterprise_project_id	Yes	String	Enterprise project ID entered by users. The value should contain 1 to 36 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed. The default value is all_granted_eps.
tags	No	String	Tag condition list.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Tenant token.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, which is used to locate auxiliary information.

**Table 5** Response body parameters
Parameter	Type	Description
instances	Array of LakeFormationInstance objects	LakeFormation instance list.
total	Integer	Total number of LakeFormation instances.

**Table 6** LakeFormationInstance
Parameter	Type	Description
instance_id	String	LakeFormation instance ID.
name	String	Instance name.
description	String	Description.
enterprise_project_id	String	Enterprise project ID.
shared	Boolean	Logical multi-tenancy or physical multi-tenancy. false indicates physical multi-tenancy and true indicates logical multi-tenancy.
default_instance	Boolean	Default instance or not.
create_time	String	Instance creation timestamp.
update_time	String	Instance update timestamp.
status	String	Instance status. RESOURCE_PREPARATION indicates that the instance is being prepared. RUNNING indicates that the instance is running. RESOURCE_RELEASE indicates that the instance is being released. DELETED indicates that the instance has been released, RESOURCE_PREPARATION_FAIL indicates that the instance preparation fails. FROZEN_RELEASABLE indicates that the instance can be restored. FROZEN_UNRELEASABLE indicates that the instance cannot be restored. RECOVERING, DELETING, and SCALING indicates that the instance is being restored, deleted, and scaled, respectively. SCALE_FAIL indicates the scaling of the instance fails. Enumeration values: RESOURCE_PREPARATION RUNNING RESOURCE_RELEASE DELETED RESOURCE_PREPARATION_FAIL FROZEN_RELEASABLE FROZEN_UNRELEASABLE RECOVERING DELETING SCALING SCALE_FAIL
in_recycle_bin	Boolean	Whether the target is in the recycle bin.
tags	Array of ResourceTag objects	Tags.

**Table 7** ResourceTag
Parameter	Type	Description
key	String	Key.
value	String	Value.

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
common_error_code	String	CBC common error code.
solution_msg	String	Solution.

Status code: 404

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
common_error_code	String	CBC common error code.
solution_msg	String	Solution.

Status code: 500

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.
common_error_code	String	CBC common error code.
solution_msg	String	Solution.

Example Requests

GET https://{endpoint}/v1/{project_id}/instances?in_recycle_bin=false

Example Responses

Status code: 200

LakeFormation instance list.

{
  "instances" : [ {
    "instance_id" : "9c368079-6401-4886-991d-0b1bb11e3702",
    "name" : "LakeFormation_instance",
    "description" : "string",
    "enterprise_project_id" : "0",
    "shared" : false,
    "create_time" : "2022-11-08T04:08:39.000+00:00",
    "update_time" : "2022-11-08T04:08:40.000+00:00",
    "status" : "RUNNING",
    "in_recycle_bin" : false
  }, {
    "instance_id" : "dec259f5-c7a8-413e-91b3-67d66c512680",
    "name" : "LakeFormation_instance_test",
    "description" : "string",
    "enterprise_project_id" : "0",
    "shared" : false,
    "create_time" : "2022-11-08T04:07:42.000+00:00",
    "update_time" : "2022-11-08T04:07:42.000+00:00",
    "status" : "RUNNING",
    "in_recycle_bin" : false
  } ],
  "total" : 2
}

Status code: 400

Bad Request

{
  "error_code" : "common.01000001",
  "error_msg" : "failed to read http request, please check your input, code: 400, reason: Type mismatch., cause: TypeMismatchException"
}

Status code: 401

Unauthorized

{
  "error_code": 'APIG.1002',
  "error_msg": 'Incorrect token or token resolution failed'
}

Status code: 403

Forbidden

{
  "error" : {
    "code" : "403",
    "message" : "X-Auth-Token is invalid in the request",
    "error_code" : null,
    "error_msg" : null,
    "title" : "Forbidden"
  },
  "error_code" : "403",
  "error_msg" : "X-Auth-Token is invalid in the request",
  "title" : "Forbidden"
}

Status code: 404

Not Found

{
  "error_code" : "common.01000001",
  "error_msg" : "response status exception, code: 404"
}

Status code: 408

Request Timeout

{
  "error_code" : "common.00000408",
  "error_msg" : "timeout exception occurred"
}

Status code: 500

Internal Server Error

{
  "error_code" : "common.00000500",
  "error_msg" : "internal error"
}

Status Codes

Status Code	Description
200	LakeFormation instance list.
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
408	Request Timeout
500	Internal Server Error

Error Codes

See Error Codes.

Parent topic: Instance Management

Previous topic: Creating an Instance

Next topic: Deleting an Instance

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot