华为云用户手册

URI GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/save-image-job 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 training_job_id 是 String 训练作业ID。获取方法请参见查询训练作业列表。 task_id 是 String 训练作业的任务名称。可从训练作业详情中的status.tasks字段中获取。

响应参数 状态码： 204 表2 响应Body参数 参数 参数类型 描述 tags Array of PoolTag objects 资源标签的列表。 表3 PoolTag 参数 参数类型 描述 key String 资源类型的标签 values Array of strings 资源类型的标签值 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK。 { "statistics" : { "status" : { "created" : 3, "creating" : 0, "failed" : 1, "pending" : 0 } }, "operationTime" : "2022-12-05 11:15:59.329633162 +0000 UTC" } 状态码： 500 Internal error { "error_code" : "ModelArts.50005000", "error_msg" : "internal error" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 statistics statistics object 资源池统计信息。 operationTime String 统计的时间。 表4 statistics 参数 参数类型 描述 status status object 不同状态下的资源池统计信息。 表5 status 参数 参数类型 描述 creating Integer 正在创建中的资源池数量。 created Integer 创建成功的资源池数量。 failed Integer 最近三天内创建失败的资源池数量，最大值为500。 pending Integer 等待中的资源池数量，通常是未支付的包周期资源池。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK。 { "apiVersion" : "v2", "kind" : "PoolMetricsList", "items" : [ { "table" : { "allocated" : { "value" : { "cpu" : 5, "memory" : "15548Mi", "tnt004" : "1073m" }, "timestamp" : "2022-03-30T07:09:10Z", "window" : "1m" }, "capacity" : { "value" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "maxValue" : { "cpu" : 16, "memory" : "64Gi", "tnt004" : 2 }, "timestamp" : "2022-03-30T07:09:10Z", "window" : "1m" } }, "metadata" : { "name" : "hougang-rse-pool" } } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 apiVersion String 资源版本。可选值如下： os.modelarts.xxxxx/v2 kind String 资源类型。可选值如下： PoolMetricsList items Array of MetricsItem objects 指标列表。 表3 MetricsItem 参数 参数类型 描述 table table object 资源列表。 metadata ResourceMetricsMetadata object 资源指标的元信息。 表4 table 参数 参数类型 描述 allocated Allocated object 资源已分配量。 capacity Capacity object 资源总容量。 表5 Allocated 参数 参数类型 描述 value Value object 资源量。 timestamp String UTC时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 window String 统计间隔，1s表示1秒，1m表示1分钟，1h为1小时。 表6 Capacity 参数 参数类型 描述 value Value object 资源量。 maxValue Value object 最大弹性资源量。 timestamp String UTC时间，格式yyyy-MM-dd'T'HH:mm:ss'Z'。 window String 统计间隔，1s表示1秒，1m表示1分钟，1h为1小时。 表7 Value 参数 参数类型 描述 cpu String cpu量，即计算资源量。 memory String 内存。 tnt004 String GPU卡的数量。 表8 ResourceMetricsMetadata 参数 参数类型 描述 name String 资源指标的名称。 labels Object 资源指标的标签信息。

响应示例 状态码： 200 OK。 { "metrics" : [ { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "cpuUsage", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : 7.944 } ] }, { "timestamp" : 1655197200000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : 7.88 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "memUsedRate", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : 13.83 } ] }, { "timestamp" : 1655197200000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : 13.836 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "gpuUtil", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : -1 } ] }, { "timestamp" : 1655197200000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : -1 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "gpuMemUsage", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : -1 } ] }, { "timestamp" : 1655197200000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : -1 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "npuUtil", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "", "statistics" : [ { "statistic" : "average", "value" : -1 } ] }, { "timestamp" : 1655197200000, "unit" : "", "statistics" : [ { "statistic" : "average", "value" : -1 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "npuMemUsage", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "", "statistics" : [ { "statistic" : "average", "value" : -1 } ] }, { "timestamp" : 1655197200000, "unit" : "", "statistics" : [ { "statistic" : "average", "value" : -1 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "diskAvailableCapacity", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Megabytes", "statistics" : [ { "statistic" : "average", "value" : 834383.4 } ] }, { "timestamp" : 1655197200000, "unit" : "Megabytes", "statistics" : [ { "statistic" : "average", "value" : 834379.2 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "diskCapacity", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Megabytes", "statistics" : [ { "statistic" : "average", "value" : 1105920 } ] }, { "timestamp" : 1655197200000, "unit" : "Megabytes", "statistics" : [ { "statistic" : "average", "value" : 1105920 } ] } ] }, { "metric" : { "dimensions" : [ { "name" : "clusterId", "value" : "83df17f1-d74c-11ec-a070-0255ac1000c3" } ], "metricName" : "diskUsedRate", "namespace" : "PAAS.AGGR" }, "dataPoints" : [ { "timestamp" : 1655193600000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : 24.553 } ] }, { "timestamp" : 1655197200000, "unit" : "Percent", "statistics" : [ { "statistic" : "average", "value" : 24.553 } ] } ] } ] } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "pool not found" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 metrics Array of metrics objects 指标对象列表。 取值范围 JSON数组大小不超过20。 表4 metrics 参数 参数类型 描述 metric metric object 指标参数集合。 dataPoints Array of dataPoints objects 重点指标。 表5 metric 参数 参数类型 描述 dimensions Array of dimensions objects 指标维度列表。 metricName String 指标名称。 namespace String 指标命名空间。可选值如下： PAAS.CONTAINER：组件指标、实例指标、进程指标和容器指标的命名空间 PAAS.NODE： 主机指标、网络指标、磁盘指标和文件系统指标的命名空间 PAAS.SLA：SLA指标的命名空间 PAAS.AGGR：集群指标的命名空间 CUSTOMMETRI CS ：默认的自定义指标的命名空间 表6 dimensions 参数 参数类型 描述 name String 指标维度名称。 value String 指标维度取值。 表7 dataPoints 参数 参数类型 描述 timestamp Integer 时间戳。 unit String 时间序列单位。 statistics Array of statistics objects 统计值列表。 表8 statistics 参数 参数类型 描述 statistic String 统计方式。 value Float 统计结果。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK。 { "kind" : "Pool", "apiVersion" : "v2", "metadata" : { "name" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T03:10:40Z", "labels" : { "os.modelarts/name" : "auto-pool-os", "os.modelarts/workspace.id" : "0", "os.modelarts/resource.id" : "maos-auto-pool-os-72w8d" }, "annotations" : { "os.modelarts/description" : "", "os.modelarts/billing.mode" : "0" } }, "spec" : { "type" : "Dedicate", "scope" : [ "Train", "Infer" ], "resources" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2 } ], "network" : { "name" : "network-maos-86c13962597848eeb29c5861153a391f" } }, "status" : { "phase" : "Running", "root" : "auto-pool-os-86c13962597848eeb29c5861153a391f", "scope" : [ { "scopeType" : "Train", "state" : "Enabled" }, { "scopeType" : "Infer", "state" : "Enabled" } ], "resources" : { "available" : [ { "flavor" : "modelarts.vm.cpu.4ud", "count" : 2, "azs" : [ { "az" : "cn-north-7c", "count" : 2 } ] } ] } } } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50015001", "error_msg" : "pool not found" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 apiVersion String API版本。可选值如下： v2 kind String 资源类型。可选值如下： Pool：资源池 metadata PoolMetadata object 资源池的metadata信息。 spec PoolSpecModel object 资源池的期望信息。 status PoolStatus object 资源池的状态信息。 表4 PoolMetadata 参数 参数类型 描述 name String 系统自动生成的pool名称，相当于pool ID。 creationTimestamp String 时间戳，例如"2021-11-01T03:49:41Z"。 labels PoolMetaLabels object 资源池的标签信息。 annotations PoolMetaAnnotations object 资源池的注释信息。 表5 PoolMetaLabels 参数 参数类型 描述 os.modelarts/workspace.id String 工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。 os.modelarts/name String 用户指定的pool名称。 os.modelarts/resource.id String 资源池的主资源id，通常提供给cbc使用。 os.modelarts/tenant.domain.id String 资源池的租户id，记录资源池创建在哪个租户账号下。 表6 PoolMetaAnnotations 参数 参数类型 描述 os.modelarts/description String 资源池的描述信息。 os.modelarts/billing.mode String 计费模式。可选值如下： 0：按需计费 1：包周期计费 os.modelarts/period.num String 包周期订购周期，比如2。 os.modelarts/period.type String 包周期订购类型。可选值如下： 2：月 3：年 4：小时 os.modelarts/auto.renew String 是否自动续费.可选值如下： 0：不自动续费，默认值 1：自动续费 os.modelarts/promotion.info String 用户在cbc选择的折扣信息。 os.modelarts/service.console.url String 订购订单支付完成后跳转的url地址。 os.modelarts/order.id String 订单id，包周期资源池创建或者计费模式变更的时候该参数必需。 os.modelarts/flavor.resource.ids String 每种规格对应的resourceId，主要和cbc交互使用。 os.modelarts/tms.tags String 创建的时候由用户指定的TMS标签。 表7 PoolSpecModel 参数 参数类型 描述 type String 资源池类型。可选值如下： Dedicate：物理资源池，独立的网络，支持网络打通，定制驱动，定制作业类型。 scope Array of strings 资源池支持的作业类型。至少选择一种，物理资源池支持全部选择。可选值如下： Train：训练作业 Infer：推理作业 Notebook：Notebook作业 resources Array of resources objects 资源池中的资源规格信列表，包括资源规格和相应规格的资源数量。 network network object 资源池网络参数。物理资源池时必选。 jobFlavors Array of strings 资源池支持的作业规格信息列表，内容为作业规格名称。 driver PoolDriver object 资源池的驱动信息。 controlMode Integer 资源池的受限状态。可选值如下： 0：代表不受限 1：转包周期受限 2：规格变更受限 4：服务受限 8：冻结 16：公安冻结（不可退订） 另外状态是可以叠加的，比如9代表转包周期受限+冻结状态。 表8 resources 参数 参数类型 描述 flavor String 资源规格，比如：modelarts.vm.gpu.tnt004。 count Integer 相应规格资源数量。 azs Array of PoolNodeAz objects az列表信息。 表9 PoolNodeAz 参数 参数类型 描述 az String 可用区名称。 count Integer 指定可用区扩容时，指定可用区的节点数。 表10 network 参数 参数类型 描述 name String 网络名称；用户接口通过指定网络名称创建网络，系统会自动创建子网，用户无法创建子网。默认将创建在第一个子网下。 表11 PoolDriver 参数 参数类型 描述 gpuVersion String GPU驱动版本，物理资源池中含有GPU规格时可填，例如："440.33"。 npuVersion String NPU驱动版本，物理资源池中含有ascend规格时可填，例如："C78"。 updateStrategy String 驱动升级策略。可选值如下： force：强制升级，立即升级节点驱动，可能影响节点上正在运行的作业 idle：安全升级，待节点上没有作业运行时进行驱动升级 表12 PoolStatus 参数 参数类型 描述 phase String 资源池集群状态。可选值如下： Creating：创建中 Running：运行中 Abnormal：资源池不正常 Deleting：删除中 Error：资源池错误 message String 资源池处于当前状态的提示信息。 resources resources object 资源池中不同状态的资源量。 scope Array of scope objects 资源池业务状态信息。 driver driver object 资源池驱动信息。 parent String 资源池父节点名称，物理池为空。 root String 资源池根节点名称，物理池为自己的名称。 表13 resources 参数 参数类型 描述 creating PoolResourceFlavorCount object 状态为创建中状态的资源量。 available PoolResourceFlavorCount object 状态为可用状态的资源量。 abnormal PoolResourceFlavorCount object 状态为非正常状态的资源量。 deleting PoolResourceFlavorCount object 状态为删除中状态的资源量。 表14 PoolResourceFlavorCount 参数 参数类型 描述 flavor String 资源规格名称，比如：modelarts.vm.gpu.tnt004。 count Integer 规格保障使用量。 maxCount Integer 资源规格的弹性使用量，物理池该值和count相同。 azs Array of azs objects 资源所在的AZ的数量。 nodePool String 节点池名称。比如：nodePool-1。 表15 azs 参数 参数类型 描述 az String AZ的名称。 count Integer AZ的资源数量。 表16 scope 参数 参数类型 描述 scopeType String 业务类型。可选值如下： Train：训练任务 Infer：推理任务 Notebook：Notebook作业 state String 业务状态。可选值如下： Enabling：启动中 Enabled：已启动 Disabling：关闭中 Disabled：已关闭 表17 driver 参数 参数类型 描述 gpu PoolDriverStatus object GPU驱动信息。 npu PoolDriverStatus object NPU驱动信息。 表18 PoolDriverStatus 参数 参数类型 描述 version String 当前驱动版本。 state String 当前驱动状态。可选值如下： Creating：创建中 Upgrading：升级中 Running：运行中 Abnormal：不正常 状态码： 404 表19 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

URI GET /v1/{project_id}/plugintemplates/{plugintemplate_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 plugintemplate_name 是 String 插件模板的名称。可选值如下： gpu-driver：GPU驱动插件模板信息 npu-driver：NPU驱动插件模板信息

响应示例 状态码： 200 OK。 { "apiVersion" : "v1", "kind" : "PluginTemplate", "metadata" : { "name" : "npu-driver" }, "spec" : { "type" : "npuDriver", "description" : "npu driver", "versions" : { } } } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50005101", "error_msg" : "Plugintemplate {name} not found." }

响应示例 状态码： 200 OK。 { "quotas" : { "resources" : [ { "type" : "pool", "quota" : 15, "used" : 10 }, { "type" : "network", "quota" : 15, "used" : 10 } ] } }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 quotas Quota object 资源配额。 表3 Quota 参数 参数类型 描述 resources Array of ResourceQuota objects 资源的配额信息。 表4 ResourceQuota 参数 参数类型 描述 type String 资源类型。 quota String 资源配额上限。 used String 已使用配额。 状态码： 404 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 networkCidrs Array of strings 网络配置项。 networkQuota Integer 用户可创建网络个数配额。 poolQuota Integer 用户可创建资源池个数配额。 pooHighAvailable Boolean 当前环境/局点是否支持创建高可用资源池。 状态码： 404 表3 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

请求示例 如下以查询uuid为2cd88daa-31a4-40a8-a58f-d186b0e93e4f的训练作业对应work-0日志OBS临时链接为例。 GET https://endpoint/v2/{project_id}/training-jobs/2cd88daa-31a4-40a8-a58f-d186b0e93e4f/tasks/worker-0/logs/url?Content-Type=text/plain

URI GET /v2/{project_id}/training-jobs/{training_job_id}/tasks/{task_id}/logs/url 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 training_job_id 是 String 训练作业ID。获取方法请参见查询训练作业列表。 task_id 是 String 训练作业的任务名称。可从训练作业详情中的status.tasks字段中获取。

响应示例 状态码： 200 ok { "obs_url" : "http://10.155.101.248:20000/cnnorth4-test/xk/00chess_test/test11/logs/modelarts-job-0f2ccdbb-4f34-4d53-afb9-d526f3be8c68-ma-platform-init-worker-0-172.16.24.51-01909681.log?AWSAccessKeyId=xxxxx" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 tags Array of CombineTmsTags objects 标签的融合结构，相同key合并。 表3 CombineTmsTags 参数 参数类型 描述 key String 标签的key。 values Array of strings 相同key的标签value合并后的列表。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

响应示例 状态码： 200 OK { "description" : "api-test", "feature" : "NOTEBOOK", "flavor" : "modelarts.vm.cpu.2u", "id" : "f9937afa-631e-4a8f-a8f7-3b6c800585f0", "image" : { "id" : "e1a07296-22a8-4f05-8bc8-e936c8e54090", "name" : "notebook2.0-mul-kernel-cpu-cp36", "swr_path" : "swr.xxxxx.com/atelier/notebook2.0-mul-kernel-cpu-cp36:3.3.1.B007_V2", "type" : "BUILD_IN" }, "lease" : { "create_at" : 1638778344300, "duration" : 3600000, "enable" : true, "update_at" : 1638778344300 }, "name" : "notebooks_test", "status" : "CREATING", "token" : "7b22482a-a4cb-4b46-e3b3-6a793a47967e", "url" : "https://authoring-modelarts-xxxxx.xxxxx.com/f9937afa-631e-4a8f-a8f7-3b6c800585f0/lab", "workspace_id" : "0" }

URI GET /v2/{project_id}/pools/{pool_name}/nodepools/{nodepool_name} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。 pool_name 是 String 资源池名称。 nodepool_name 是 String 节点池名称。 表2 Query参数 参数 是否必选 参数类型 描述 continue 否 String 分页查询时上一页位置。 limit 否 String 分页单次查询返回数。

响应示例 状态码： 200 OK。 { "kind" : "NodePool", "apiVersion" : "v2", "metadata" : { "name" : "nodepool-1" }, "spec" : { "resources" : { "nodePool" : "nodepool-1", "flavor" : "modelarts.vm.2u4g.dcc", "count" : 1, "maxCount" : 1, "network" : { "vpc" : "277e9abc-0e6b-431a-9232-cfd25d5fc566", "subnet" : "03796378-c356-4c14-826b-e4913aa9c8b9", "securityGroups" : [ "0a15b48d-06f1-41e4-b782-ade90087bf59" ] } } }, "status" : { "resources" : { "available" : { "nodePool" : "nodepool-1", "flavor" : "modelarts.vm.2u4g.dcc", "count" : 1, "maxCount" : 1, "azs" : [ { "az" : "cn-north-7c", "count" : 1 } ] } } } } 状态码： 400 Bad request { "error_code" : "ModelArts.50004000", "error_msg" : "Bad request. invalid nodepool name" }

响应示例 状态码： 200 OK。 { "kind" : "Network", "apiVersion" : "v1", "metadata" : { "name" : "network-7a03-86c13962597848eeb29c5861153a391f", "creationTimestamp" : "2022-09-16T09:44:59Z", "labels" : { "os.modelarts/name" : "network-7a03", "os.modelarts/workspace.id" : "0" }, "annotations" : { } }, "spec" : { "cidr" : "192.168.128.0/17", "connection" : { } }, "status" : { "phase" : "Active", "connectionStatus" : { } } } 状态码： 404 Not Found。 { "error_code" : "ModelArts.50025001", "error_msg" : "Network not exist." }

响应示例 状态码： 200 OK { "count" : 4, "total_count" : 4, "engine_runtimes" : [ { "ai_engine" : "TensorFlow", "runtimes" : [ "tf1.13-python3.6-cpu", "tf1.13-python3.6-gpu", "tf1.13-python3.7-cpu", "tf1.13-python3.7-gpu", "python3.6", "tf1.13-python3.7-aiflow-gpu", "tf1.13-python3.7-gpu-async", "tensorflow_2.1.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64", "tensorflow_2.6.0-cuda_11.2-py_3.7-ubuntu_18.04-x86_64", "tensorflow_1.15.5-cuda_11.4-py_3.8-ubuntu_20.04-x86_64" ], "request_mode" : [ "sync", "sync", "sync", "sync", "sync", "sync", "async", "sync", "sync", "sync" ], "accelerators" : [ { "type" : "none" }, { "type" : "gpu", "cuda_version" : "cuda 10.2" }, { "type" : "none" }, { "type" : "gpu", "cuda_version" : "cuda 10.2" }, { "type" : "none" }, { "type" : "gpu", "cuda_version" : "cuda 10.2" }, { "type" : "gpu", "cuda_version" : "cuda 10.2" }, { "type" : "none" }, { "type" : "none" }, { "type" : "none" } ], "arch" : [ "x86_64", "x86_64", "x86_64", "x86_64", "x86_64", "x86_64", "x86_64", "x86_64", "x86_64", "x86_64" ], "status_list" : [ "normal", "normal", "normal", "normal", "normal", "normal", "normal", "normal", "normal", "normal" ], "image_source" : [ "base_image", "base_image", "base_image", "base_image", "base_image", "base_image", "base_image", "uniform_image", "uniform_image", "uniform_image" ] }, { "ai_engine" : "PyTorch", "runtimes" : [ "python3.6", "python3.7", "pytorch1.4-python3.7", "pytorch_1.11.0-cann_7.0.1-py_3.9-euler_2.10.7-aarch64-snt9b", "pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64", "pytorch_1.8.2-cuda_11.1-py_3.7-ubuntu_18.04-x86_64" ], "request_mode" : [ "sync", "sync", "sync", "sync", "sync", "sync" ], "accelerators" : [ { "type" : "none" }, { "type" : "none" }, { "type" : "none" }, { "type" : "npu", "name" : "SNT9", "driver_version_section" : "C8x" }, { "type" : "none" }, { "type" : "none" } ], "arch" : [ "x86_64", "x86_64", "x86_64", "aarch64", "x86_64", "x86_64" ], "status_list" : [ "normal", "normal", "normal", "normal", "normal", "normal" ], "image_source" : [ "base_image", "base_image", "base_image", "uniform_image", "uniform_image", "uniform_image" ] }, { "ai_engine" : "MindSpore", "runtimes" : [ "mindspore_1.9.0-cann_6.0.1-py_3.7-euler_2.9.9-x86_64-snt3p-300i", "mindspore_1.7.0-cuda_10.1-py_3.7-ubuntu_18.04-x86_64", "mindspore_1.2.0-py_3.7-cuda_10.1-ubuntu_18.04-x86_64" ], "request_mode" : [ "sync", "sync", "sync" ], "accelerators" : [ { "type" : "none" }, { "type" : "none" }, { "type" : "none" } ], "arch" : [ "x86_64", "x86_64", "x86_64" ], "status_list" : [ "normal", "normal", "normal" ], "image_source" : [ "uniform_image", "uniform_image", "uniform_image" ] }, { "ai_engine" : "Custom", "runtimes" : [ ], "request_mode" : [ ], "accelerators" : [ ], "arch" : [ ], "status_list" : [ ], "image_source" : [ ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 count Integer 不分页的情况下符合查询条件的总数量。 total_count Integer 当前查询结果的数量，不设置offset、limit查询参数时，count与total相同。 engine_runtimes Array of EngineAndRuntimesResponse objects 引擎运行环境。 表5 EngineAndRuntimesResponse 参数 参数类型 描述 ai_engine String AI引擎类型，目前共有以下几种类型： TensorFlow PyTorch MindSpore XGBoost Scikit_Learn Spark_MLlib runtimes Array of strings 运行镜像，如pytorch_1.8.0-cuda_10.2-py_3.7-ubuntu_18.04-x86_64 request_mode Array of strings 请求模式，AI引擎支持部署为同步在线服务或异步在线服务。 sync：同步在线服务 async：异步在线服务 accelerators Array of Accelerator objects AI引擎可使用的加速卡。 arch Array of strings AI引擎架构，目前共两种： x86_64 aarch64 status_list Array of strings AI引擎状态，目前共三种： normal (正常) deleted (已下线) deleting (下线中) image_source Array of strings 镜像来源，目前共两种： base_image (基础镜像) uniform_image (统一镜像) 表6 Accelerator 参数 参数类型 描述 type String 加速卡类型，目前共三种： npu gpu none name String 加速卡名称，如SNT9B。 cuda_version String cuda驱动版本。 driver_version_section String 驱动版本集合。 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String ModelArts错误码。 error_msg String 具体错误信息。

URI GET /v1/{project_id}/models/ai-engine-runtimes 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户项目ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 String 每页显示的条目数量。 offset 否 String 偏移量，表示从此偏移量开始查询，offset大于等于0。

URI GET /v1/{project_id}/models/{model_id} 表1 路径参数 参数 是否必选 参数类型 描述 model_id 是 String 模型ID，在创建AI应用时即可在返回体中获取，也可通过查询AI应用列表接口获取当前用户拥有的AI应用，其中model_id字段即为模型ID。 project_id 是 String 用户项目ID。获取方法请参见获取项目ID和名称。

响应示例 状态码： 200 模型详情。 { "model_id" : "10eb0091-887f-4839-9929-cbc884f1e20e", "model_name" : "mnist", "model_version" : "1.0.0", "runtime" : "python2.7", "tenant" : "6d28e85aa78b4e1a9b4bd83501bcd4a1", "project" : "d04c10db1f264cfeb1966deff1a3527c", "owner" : "6d28e85aa78b4e1a9b4bd83501bcd4a1", "source_location" : "https://models.obs.xxxxx.com/mnist", "model_type" : "TensorFlow", "model_size" : 5633481, "model_status" : "published", "execution_code" : "https://testmodel.obs.xxxxx.com/customize_service.py", "image_address" : "100.125.5.235:20202/models/10eb0091-887f-4839-9929-cbc884f1e20e:1.0.0", "input_params" : [ { "url" : "/", "method" : "post", "protocol" : "http", "param_name" : "data", "param_type" : "object", "param_desc" : "{\"type\":\"object\",\"properties\":{\"req_data\":{\"items\":[{\"type\":\"object\",\"properties\":{}}],\"type\":\"array\"}}}" } ], "output_params" : [ { "url" : "/", "method" : "post", "protocol" : "http", "param_name" : "data", "param_type" : "object", "param_desc" : "{\"type\":\"object\",\"properties\":{\"resp_data\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{}}]}}}" } ], "dependencies" : [ { "installer" : "pip", "packages" : [ { "package_name" : "pkg1", "package_version" : "1.0.1", "restraint" : "ATLEAST" } ] } ], "model_metrics" : "{\"f1\":0.52381,\"recall\":0.666667,\"precision\":0.466667,\"accuracy\":0.625}", "apis" : "[{\"protocol\":\"http\",\"method\":\"post\",\"url\":\"/\",\"input_params\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"req_data\":{\"items\":[{\"type\":\"object\",\"properties\":{}}],\"type\":\"array\"}}}}},\"output_params\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"resp_data\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{}}]}}}}}}]", "model_labels" : [ ], "labels_map" : { "labels" : [ ] }, "workspace_id" : "0", "install_type" : [ "realtime", "batch", "edge" ], "specification" : { }, "config" : "{\"model_algorithm\":\"image_classification\",\"model_source\":\"auto\",\"tunable\":false,\"downloadable_flag\":true,\"algorithm\":\"resnet_v2_50,mobilenet_v1\",\"metrics\":{\"f1\":0.912078373015873,\"recall\":0.9125,\"precision\":0.9340277777777778,\"accuracy\":0.263250724969475},\"model_type\":\"TensorFlow\",\"runtime\":\"tf1.13-python3.6-cpu\",\"apis\":[{\"protocol\":\"https\",\"url\":\"/\",\"method\":\"post\",\"request\":{\"data\":{\"type\":\"object\",\"properties\":{\"images\":{\"type\":\"file\"}}},\"Content-type\":\"multipart/form-data\"},\"response\":{\"data\":{\"type\":\"object\",\"required\":[\"predicted_label\",\"scores\"],\"properties\":{\"predicted_label\":{\"type\":\"string\"},\"scores\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"minItems\":2,\"maxItems\":2,\"items\":[{\"type\":\"string\"},{\"type\":\"number\"}]}}}},\"Content-type\":\"multipart/form-data\"}}],\"dependencies\":[{\"installer\":\"pip\",\"packages\":[{\"package_name\":\"numpy\",\"package_version\":\"1.17.0\",\"restraint\":\"EXACT\"},{\"package_name\":\"h5py\",\"package_version\":\"2.8.0\",\"restraint\":\"EXACT\"},{\"package_name\":\"Pillow\",\"package_version\":\"5.2.0\",\"restraint\":\"EXACT\"},{\"package_name\":\"scipy\",\"package_version\":\"1.2.1\",\"restraint\":\"EXACT\"},{\"package_name\":\"resampy\",\"package_version\":\"0.2.1\",\"restraint\":\"EXACT\"},{\"package_name\":\"scikit-learn\",\"package_version\":\"0.19.1\",\"restraint\":\"EXACT\"}]}],\"health\":{\"check_method\":\"HTTP\",\"protocol\":\"http\",\"url\":\"/health\",\"period_seconds\":\"5\",\"failure_threshold\":\"10\",\"initial_delay_seconds\":\"12\"},\"readiness_health\":{\"check_method\":\"HTTP\",\"protocol\":\"http\",\"url\":\"/readiness_health\",\"period_seconds\":\"5\",\"failure_threshold\":\"20\",\"initial_delay_seconds\":\"12\"},\"startup_health\":{\"check_method\":\"HTTP\",\"protocol\":\"http\",\"url\":\"/startup_health\",\"period_seconds\":\"5\",\"failure_threshold\":\"10\",\"initial_delay_seconds\":\"12\"}}" }

响应示例 状态码： 200 获取推理VPC访问通道信息。 { "dns_domain_name" : "xxx.xxx.com", "vpcep_info" : [ { "vpcep_service_id" : "2275xxxx-c96f-4xxx-820c-c7xxxxxa7899", "vpcep_service_name" : "cn-nxxxx-x.vpcepname.2275xxxx-c96f-4xxx-820c-c7xxxxxa7899", "service_port" : 443 } ] } 状态码： 401 鉴权失败 { "error_code" : "ModelArts.0203", "error_msg" : "Invalid token." }

响应参数 状态码： 200 表3 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪ID。 表4 响应Body参数 参数 参数类型 描述 dns_domain_name String 页面调用指南展示的访问 域名 ，可用于添加内网DNS解析。 vpcep_info Array of InternalChannelDetail objects 检索到的VPC访问通道信息。 表5 InternalChannelDetail 参数 参数类型 描述 vpcep_service_id String VPC访问通道vpcep终端节点服务ID。 vpcep_service_name String VPC访问通道vpcep终端节点服务名称。 service_port Integer VPC访问通道的端口。 状态码： 401 表6 响应Header参数 参数 参数类型 描述 X-Request-Id String 链路追踪ID 表7 响应Body参数 参数 参数类型 描述 error_code String 服务内部错误码。 error_msg String 错误信息。