Help Center/ FunctionGraph/ API Reference/ APIs/ Function Lifecycle Management/ Updating the Pinning Status of a Function
Updated on 2024-03-14 GMT+08:00

Updating the Pinning Status of a Function

Function

This API is used to update the pinning status of a function.

URI

PUT /v2/{project_id}/fgs/functions/{func_urn}/collect/{state}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

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

func_urn

Yes

String

Function URN.

state

Yes

String

Pinning status.

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

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

Update the pinning status of a function.

PUT https://{Endpoint}/v2/{project_id}/fgs/functions/{function_urn}/collect/true

Example Responses

None

Status Codes

Status Code

Description

200

ok

500

Internal server error.

Error Codes

See Error Codes.