Help Center/ FunctionGraph/ API Reference/ APIs/ Function Lifecycle Management/ Enabling or Disabling the Snapshot Function
Updated on 2024-08-12 GMT+08:00

Enabling or Disabling the Snapshot Function

Function

This API is used to enable or disable the snapshot feature. It is available only for non-latest versions of Java functions.

URI

POST /v2/{project_id}/fgs/functions/{function_urn}/snapshots/{action}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID.

function_urn

Yes

String

Function URN. For details, see the function model description.

action

Yes

String

Enabled or disabled.

Enumeration values:

  • enable
  • disable

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Content-Type

Yes

String

Message body type (format).

Response Parameters

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

  • Enable the snapshot function.
    POST https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn/snapshots/enable
  • Disable the snapshot function.
    POST https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn/snapshots/disable

Example Responses

Status code: 404

Not found.

{
  "error_code" : "FSS.1051",
  "error_msg" : "Not found the function"
}

Status Codes

Status Code

Description

200

OK

400

Bad request.

401

Unauthorized.

403

Forbidden.

404

Not found.

500

Internal server error.

Error Codes

See Error Codes.