Help Center/ DataArts Lake Formation/ API Reference/ API/ Console/ Instance Management/ Updating an Instance
Updated on 2024-02-21 GMT+08:00
View PDF
Share

Updating an Instance

Function

This API is used to modify LakeFormation instance information.

URI

PUT /v1/{project_id}/instances/{instance_id}

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).

instance_id

Yes

String

LakeFormation instance ID. The value is automatically generated when the instance is created, for example, 2180518f-42b8-4947-b20b-adfc53981a25.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Tenant token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Instance name. The value should contain 4 to 32 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed.

description

No

String

Instance description entered by a user. The value contains a maximum of 255 characters.

Response Parameters

Status code: 200

Table 4 Response body parameters

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 5 ResourceTag

Parameter

Type

Description

key

String

Key.

value

String

Value.

Status code: 400

Table 6 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 7 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 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.

Example Requests

PUT https://{endpoint}/v1/{project_id}/instances/{instance_id}

{
  "name" : "LakeFormation_instance_update",
  "description" : "description"
}

Example Responses

Status code: 200

Instance information.

{
  "instance_id" : "01049549-82cd-4b2b-9733-ddb94350c125",
  "name" : "LakeFormation_instance",
  "description" : "string",
  "enterprise_project_id" : 0,
  "shared" : false,
  "create_time" : "2022-10-08T12:49:19.000+00:00",
  "update_time" : "2022-10-08T12:49:19.000+00:00",
  "status" : "running",
  "in_recycle_bin" : false
}

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

Instance information.

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