Custom tenant command of a function_Custom tenant command of a function_APIs_API Reference

Function

Custom tenant command of a function

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

POST /v2/{project_id}/fgs/functions/{function_urn}/command

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Parameter description: Project ID. For details, see Obtaining a Project ID. Constraints: None Value range: 32 characters, including letters and digits. Default value: None
function_urn	Yes	String	Parameter description: URN of the function. For details, see Function Model. Constraints: None Value range: Only letters, digits, underscores (_), hyphens (-), and colons (:) are allowed. Default value: None

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Parameter description: User token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints: None Value range: None Default value: None
Content-Type	Yes	String	Parameter description: Specifies the type (or format) of the message body. Constraints: None Value range: Only application/json is supported. Default value: application/json

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
command	Yes	String	Command name
runtime	No	String	Runtime
pod_name	No	Array of strings	Pod name
timeout	No	Integer	Timeout interval of the execution.
args	No	Map<String,String>	Command Parameters

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
task_id	String	Task name.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.

Status code: 403

**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

Create a task for customizing a tenant command.

POST https://{Endpoint}/v2/{project_id}/fgs/{function_urn}/command

{
  "command" : "heap",
  "runtime" : "Cangjie1.9",
  "pod_name" : [ "pod1" ],
  "timeout" : 60,
  "args" : {
    "duration" : 60
  }
}

Example Responses