部署算法 - DeployAlgorithm
功能介绍
部署算法。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/algorithm/{alg_id}/deploy
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID,获取方法参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| alg_id | 是 | String | 参数解释: 算法ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,获取方法参见认证鉴权。 约束限制: 不涉及。 取值范围: 字符串长度[0, 32768]。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| pool_id | 否 | String | 参数解释: 资源池ID,服务状态为未部署时必填。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| stream_count | 是 | Integer | 参数解释: 视频流路数。 约束限制: 不涉及。 取值范围: 1-10000 默认取值: 不涉及。 |
| deploy_config | 否 | Object | 参数解释: 服务启动参数,须按照模型的部署约束填写。类型为“Map<String, Object>”,可选填,默认为空。为确保您的数据安全,在环境变量中,请勿输入敏感信息,如明文密码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| envs | 否 | Object | 参数解释: 运行服务需要的环境变量键值对。类型为“Map<String, String>”,可选填,默认为空。为确保您的数据安全,在环境变量中,请勿输入敏感信息,如明文密码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| alg_name | String | 参数解释: 算法名称。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息描述。 取值范围: 不涉及。 |
| detail | String | 参数解释: 错误详情。 取值范围: 不涉及。 |
| params | Array of strings | 参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
| reason | String | 参数解释: 错误原因。 取值范围: 不涉及。 |
| advice | String | 参数解释: 建议。 取值范围: 不涉及。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误信息描述。 取值范围: 不涉及。 |
| detail | String | 参数解释: 错误详情。 取值范围: 不涉及。 |
| params | Array of strings | 参数解释: 错误参数列举。 取值范围: 列表长度[0, 1]。 |
| reason | String | 参数解释: 错误原因。 取值范围: 不涉及。 |
| advice | String | 参数解释: 建议。 取值范围: 不涉及。 |
请求示例
部署算法,配置资源池ID、可承载的最大路数和服务启动参数
GET https://{endpoint}/v2/{project_id}/algorithm/068ed4d8-077e-4ec9-aa19-bc******e925/deploy
{
"pool_id" : "ed9f128bf7d04f5683f0ef******a255",
"stream_count" : 1,
"deploy_config" : {
"sub_scene" : "common"
}
} 响应示例
状态码:200
部署算法响应体。
{
"alg_name" : "入侵检测"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 部署算法响应体。 |
| 400 | 请求错误。 |
| 500 | 内部错误。 |