函数自定义租户命令 - CreateTenantCommand
功能介绍
函数自定义租户命令
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v2/{project_id}/fgs/functions/{function_urn}/command
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 租户项目 ID,获取方式请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为32个字符。 默认取值: 不涉及。 |
| function_urn | 是 | String | 参数解释: 函数的URN,详细解释见FunctionGraph函数模型的描述。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字、下划线、中划线、冒号组成。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 只能为application/json 默认取值: application/json |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| command | 是 | String | 命令名称 |
| runtime | 否 | String | 运行时 |
| pod_name | 否 | Array of strings | pod名称 |
| timeout | 否 | Integer | 执行超时时间 |
| args | 否 | Map<String,String> | 命令参数 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| task_id | String | 任务名称 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码 |
| error_msg | String | 错误信息 |
请求示例
创建租户自定义命令任务。
POST https://{Endpoint}/v2/{project_id}/fgs/{function_urn}/command
{
"command" : "heap",
"runtime" : "Cangjie1.9",
"pod_name" : [ "pod1" ],
"timeout" : 60,
"args" : {
"duration" : 60
}
} 响应示例
状态码:200
{
"task_id" : "52b8abae-2230-479a-959e-602176d6151e"
} 状态码:400
{
"error_code" : "FSS.0400",
"error_msg" : "Invalid parameter."
} 状态码:401
{
"error_code" : "FSS.0401",
"error_msg" : "Unauthorized access."
} 状态码:403
{
"error_code" : "FSS.0403",
"error_msg" : "Forbidden"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | ok |
| 400 | Invalid parameter. |
| 401 | Unauthorized |
| 403 | Forbidden |
| 500 | Internal Server Error 服务内部错误。 |
错误码
请参见错误码。