Help Center/ FunctionGraph/ API Reference/ APIs/ Function Lifecycle Management/ Querying Snapshot Status
Updated on 2024-03-14 GMT+08:00
View PDF

Querying Snapshot Status

Function

This API is used to query the snapshot status of a function.

URI

GET /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

Query snapshot status or whether snapshot cold start is used.

Enumeration values:

  • state

  • enableSnapshot

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

Table 3 Response body parameters

Parameter

Type

Description

state

String

Snapshot status.

code

String

Snapshot response code.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Query the snapshot status of a function.

GET https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/snapshots/state

Example Responses

Status code: 200

OK

{
  "state" : "enable"
}

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.