云服务器内容精选

  • 响应示例 状态码: 200 技能订单详情 { "expiration_stop_flag" : null, "package_order_id" : null, "icon" : null, "commission_flag" : 0, "product_info" : [ ], "package_id" : null, "measure_type" : "physical_src", "update_time" : 1654569785847, "channel_limit" : 0, "resource_step_size" : 1, "cloud_service_type" : null, "developer_id" : "07e463f65280d2d62f2ec010fcd10f1c", "amount" : 10, "format" : "image", "resource_type" : null, "measure_unit" : "road", "skill_chip" : null, "versions" : [ "0.0.1" ], "skill_name" : "skill-free", "skill_type" : null, "used_amount" : 0, "charge_model" : 0, "resource_spec_code" : null, "skill_id" : "26d00abae3a44c24a820ae9e92fe53c4", "skill_platform" : null, "order_limit" : null, "order_id" : "149d60137d634a81b5a4c7033e38e04d", "status" : 0}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 expiration_stop_flag Integer 技能是否支持永久使用标识。1标识支持,0为不支持 package_order_id String 技能套餐包订单ID icon String 技能图标 commission_flag Integer 定制技能标识 product_info Array of strings 产品收费编码信息 package_id String 套餐包ID measure_type String 计费类型,physical_src表示按物理量纲收费,比如包周期 ,src表示一次性收费 update_time Integer 更新时间 channel_limit Integer 通道数限制 resource_step_size Integer 步长 cloud_service_type String 云服务编码 developer_id String 开发者ID amount Integer 订单数量 format String 技能类型,文件类型file,镜像类型iamge resource_type String 资源类别 expire_time Long 到期时间 measure_unit String 计费单位 qps 表示按qps收费,road表示技能路数instance 表示按实例收费 skill_chip String 芯片类别 versions Array of strings 技能版本列表 skill_name String 技能名字 skill_type String 技能类别 used_amount Integer 订单使用份数 charge_model Integer 计费模式 resource_spec_code String 资源编码 skill_id String 技能ID skill_platform String 技能支持的平台 order_limit Integer 订单购买限制 order_id String 订单ID status Integer 订单状态,0表示正常状态,1表示冻结状态,2表示受限状态
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户Token。获取方法请参见 获取Token 表3 请求Body参数 参数 是否必选 参数类型 描述 business 否 String 作业动作,创建作业或者是删除作业又或是更新作业等 data 是 TaskData object 作业详情 description 否 String 作业描述 instance_id 否 String 实例ID,非必选 name 是 String 作业名称 timestamp 否 String 时间戳,非必选 表4 TaskData 参数 是否必选 参数类型 描述 streams 是 Array of TaskStream objects 作业流详情 task_id 否 String 作业id start_time_info 否 StartTimeInfo object 任务启动信息 source_usage_estimate 否 TaskSourceUsageEstimate object 资源消耗 表5 TaskStream 参数 是否必选 参数类型 描述 common 否 Object 作业参数配置 input 是 TaskInput object 输入详情 outputs 是 Array of TaskOutputs objects 输出详情 表6 TaskInput 参数 是否必选 参数类型 描述 data 是 Object 输入数据 type 是 String 输入类型 表7 TaskOutputs 参数 是否必选 参数类型 描述 data 是 Object 输出数据 type 是 String 输出类型 表8 StartTimeInfo 参数 是否必选 参数类型 描述 start_time 是 String 任务启动时间 frequency 否 String 任务运行频率(定时任务频率,每天运行还是单次运行) mode 否 String 任务运行模式(按时间段运行还是按频率运行) day_time_frame 否 Array of TimeFrame objects 每天运行时间段 single_time_frame 否 Array of TimeFrame objects 每次运行时间段 表9 TimeFrame 参数 是否必选 参数类型 描述 start 是 String 任务开始时间 stop 是 String 任务结束时间 表10 TaskSourceUsageEstimate 参数 是否必选 参数类型 描述 cpu 是 Float cpu消耗 memory 是 Integer 内存消耗
  • 请求示例 新建一个作业 POST https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/tasks{ "business" : "string", "data" : { "streams" : [ { "common" : { }, "input" : { "data" : { }, "type" : "string" }, "outputs" : [ { "data" : { }, "type" : "string" } ] } ], "task_id" : "string", "start_time_info" : { "start_time" : "string", "frequency" : "string", "mode" : "string", "day_time_frame" : [ { "start" : "string", "stop" : "string" } ], "single_time_frame" : [ { "start" : "string", "stop" : "string" } ] } }, "description" : "string", "instance_id" : "string", "name" : "string", "timestamp" : "string"}
  • 请求示例 删除指定实例 DELETE https://{endpoint}/v3/{project_id}/ai-mgr/deployments/{deployment_id}/{pod_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • URI DELETE /v3/{project_id}/ai-mgr/deployments/{deployment_id}/{pod_id} 表1 路径参数 参数 是否必选 参数类型 描述 deployment_id 是 String 应用部署ID pod_id 是 String 实例ID project_id 是 String 项目ID,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 force_delete 否 Boolean 是否强制删除,为true的时候为强制删除
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 pod_id String pod的ID 状态码: 401 表5 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息 状态码: 403 表6 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息 状态码: 404 表7 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息 状态码: 500 表8 响应Body参数 参数 参数类型 描述 request_id String 请求ID error_code String 错误码 error_message String 错误信息
  • 请求示例 获取部署列表 GET https://{endpoint}/v3/{project_id}/ai-mgr/deploymentsRequest Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • 响应示例 状态码: 200 请求成功 { "count" : 1, "deployments" : [ { "template" : { "configs" : { "migration" : false, "host_network" : false, "host_pid" : false, "restart_policy" : "Always", "toleration_seconds" : 0 }, "apps" : [ { "name" : "food-detection-skill", "args" : [ ], "command" : [ ], "resources" : { "limits" : { "cpu" : "0.25", "memory" : "128" }, "requests" : { } }, "envs" : [ ], "msgs" : [ ], "ports" : [ ], "privileged" : false, "version" : "1.0.5", "volumes" : [ ], "app_url" : "xxx", "is_modelbox" : false } ] }, "reason" : null, "ready_replicas" : 0, "replicas" : 1, "description" : null, "created_at" : "2022-01-13 16:56:27 GMT+08:00", "source" : "userdefined", "api_version" : null, "node_ids" : [ "hilens-ddafe05724364df7bcd1f5e1f9971793" ], "cluster_id" : null, "updated_at" : "2022-01-13 16:56:27 GMT+08:00", "project_id" : "fff47e1722f94c4e98531bae56821372", "name" : "food-detection", "id" : "hilens-849c8575bc2a401c8cd7a979d999c8ef", "state" : "RUNNING" } ]}
  • URI GET /v3/{project_id}/ai-mgr/deployments 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 cluster_id 否 String 集群ID,查询部署在该节点组的应用列表,和node_id不可同时请求 node_id 否 String 节点ID,查询部署在该节点下的应用列表,和cluster_id不可同时请求 provider 否 String 平台提供者,分别为hilens及ief。当为hilens时,请求部署在hilens平台的相关数据 name 否 String 部署名称(支持模糊匹配) sort 否 String 查询结果排序,如按照创建时间降序排序为created_at:desc,升序排序为created_at:asc limit 否 Integer 每页显示的条目数量, 最大 100,默认值 10 offset 否 Integer 查询的起始位置, 默认值 0
  • 请求示例 删除指定ID的工作空间 DELETE https://{endpoint}/v3/{project_id}/ai-mgr/workspaces/{workspace_id}Request Header: Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
  • 响应示例 状态码: 200 技能订单详情 { "expiration_stop_flag" : null, "package_order_id" : null, "icon" : null, "commission_flag" : 0, "product_info" : [ ], "package_id" : null, "measure_type" : "physical_src", "update_time" : 1654569785847, "channel_limit" : 0, "resource_step_size" : 1, "cloud_service_type" : null, "developer_id" : "07e463f65280d2d62f2ec010fcd10f1c", "amount" : 10, "format" : "image", "resource_type" : null, "measure_unit" : "road", "skill_chip" : null, "versions" : [ "0.0.1" ], "skill_name" : "skill-free", "skill_type" : null, "used_amount" : 0, "charge_model" : 0, "resource_spec_code" : null, "skill_id" : "26d00abae3a44c24a820ae9e92fe53c4", "skill_platform" : null, "order_limit" : null, "order_id" : "149d60137d634a81b5a4c7033e38e04d", "status" : 0}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 expiration_stop_flag Integer 技能是否支持永久使用标识。1标识支持,0为不支持 package_order_id String 技能套餐包订单ID icon String 技能图标 commission_flag Integer 定制技能标识 product_info Array of strings 产品收费编码信息 package_id String 套餐包ID measure_type String 计费类型,physical_src表示按物理量纲收费,比如包周期 ,src表示一次性收费 update_time Integer 更新时间 channel_limit Integer 通道数限制 resource_step_size Integer 步长 cloud_service_type String 云服务编码 developer_id String 开发者ID amount Integer 订单数量 format String 技能类型,文件类型file,镜像类型iamge resource_type String 资源类别 expire_time Long 到期时间 measure_unit String 计费单位 qps 表示按qps收费,road表示技能路数instance 表示按实例收费 skill_chip String 芯片类别 versions Array of strings 技能版本列表 skill_name String 技能名字 skill_type String 技能类别 used_amount Integer 订单使用份数 charge_model Integer 计费模式 resource_spec_code String 资源编码 skill_id String 技能ID skill_platform String 技能支持的平台 order_limit Integer 订单购买限制 order_id String 订单ID status Integer 订单状态,0表示正常状态,1表示冻结状态,2表示受限状态
  • 响应示例 状态码: 200 请求成功 { "count" : "1;", "secrets" : [ { "id" : "string", "name" : "string", "description" : "string", "workspace_id" : "string", "project_id" : "string", "created_at" : "string", "updated_at" : "string", "secrets" : [ { "key" : "string", "value" : "string" } ], "tags" : [ { "key" : "string", "value" : "string" } ] } ]}
  • URI GET /v3/{project_id}/ai-mgr/secrets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见获取项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 limit 否 Integer 每页显示的条目数量,取值范围1~100,默认为100 name 否 String 设备名称,模糊匹配,只允许中文字符、英文字母、数字、下划线、中划线,最大长度64 workspace_id 否 String 工作空间ID,默认为注册账号子账号的default工作空间,可通过专业版HiLens控制台展开工作空间列表获取到工作空间ID tags 否 String 标签的key和value通过点连接,多个标签通过逗号连接,如:tags=key1.value1,key2.value2 provider 否 String 服务提供者:ief或hilens。不传会查询全部服务类型的设备列表 sort 否 String 排序方式,可根据名称、创建时间、更新时间排序枚举值:name,created_at,updated_at。sort默认升序,如sort=name,降序:sort=name%3Adesc。不填默认为sort=created_at%3Adesc。