华为云用户手册

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 表2 update_job_description请求参数说明 参数 是否必选 参数类型 描述 description 是 String 需要更改的训练作业的描述信息。 表3 update_job_description返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 场景1：查询当前用户所有服务对象 1 2 3 4 5 6 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_list_object_resp = Predictor.get_service_object_list(session) print(predictor_list_object_resp) 场景2：按照检索条件查询当前用户服务对象 1 2 3 4 5 6 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_object_list = Predictor.get_service_object_list(session, service_name="digit", order="asc", offset="0", infer_type="real-time") print(predictor_object_list)

参数说明 查询服务列表，返回list，list大小等于当前用户所有已经部署的服务个数，list中每个元素都是Predictor对象，对象属性同本章初始化服务。 查询服务列表返回说明：service_list_resp = [service_instance1, service_instance2, service_instance3 ...]，列表中元素“service_instance”对象即为服务管理章节描述的可调用服务接口。 支持按照检索参数查询服务列表，返回满足检索条件的服务list，检索参数如表1所示。 在查询列表时，返回list的同时，默认会打印模型列表的详细信息，如表2和表3所示。 表1 查询检索参数说明 参数 是否必选 参数类型 描述 session 是 Object 会话对象，初始化方法见Session鉴权。 is_show 否 Boolean 是否打印出服务对象信息，默认为“True”。 service_id 否 String 服务ID，默认不过滤服务ID。 service_name 否 String 服务名称，默认不过滤服务名。 infer_type 否 String 推理方式，取值为：real-time/batch/edge，默认不过滤推理方式。 offset 否 Integer 分页列表的起始页，默认为“0”。 limit 否 Integer 指定每一页返回的最大条目数，默认为“1000”。 sort_by 否 String 指定排序字段，可选“publish_at”、“service_name”，默认可选“publish_at”。 order 否 String 排序方式，可选“asc”或“desc”，代表递增排序及递减排序，默认为：“desc”。 model_id 否 String 模型ID，默认不过滤模型ID。

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 config_name 是 String 训练作业参数名称。 表2 delete_job_configs返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一： 根据指定的config_name删除 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, config_name="my_job_config") status = estimator.delete_job_configs() 方式二： 根据创建训练作业参数生成的训练作业版本对象删除 1 status = job_config_instance.delete_job_configs() 方式三： 根据查询训练作业参数对象列表返回的指定训练作业版本对象删除 1 status = job_config_instance_list[0].delete_job_configs()

参数说明 表1 VisualizationJob请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 visualization_id 是 String 可视化作业ID。 表2 get_visualization_job_info返回参数说明 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 job_name String 可视化作业的名称。 service_url String 可视化作业的endpoint。 is_success Boolean 接口调用是否成功。 duration Long 可视化训练作业的运行时间。 create_time Long 可视化训练作业的创建时间。 train_url String 可视化训练作业输出文件OBS路径。 job_id Long 可视化训练作业的ID。 job_desc String 可视化训练作业的描述信息。 resource_id String 可视化训练作业的资源ID。 status Integer 可视化作业的运行状态，详细作业状态列表请参见作业状态参考。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一： 根据指定的visualization_id查询 1 2 3 4 5 6 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job = VisualizationJob(modelarts_session=session, visualization_id='8992') job_info = job.get_visualization_job_info() print(job_info) 方式二： 根据创建可视化作业生成的可视化作业对象查询 1 2 job_info = job_visualization_instance.get_visualization_job_info() print(job_info) 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象查询 1 2 job_info = job_visualization_instance_list[0].get_visualization_job_info() print(job_info)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一： 根据指定的visualization_id重启 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job = VisualizationJob(modelarts_session=session, visualization_id='8992') resp = job.restart_visualization_job() 方式二： 根据创建可视化作业生成的可视化作业对象重启 1 status = job_visualization_instance.restart_visualization_job() 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象重启 1 status = job_visualization_instance_list[0].restart_visualization_job()

参数说明 表1 VisualizationJob请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 visualization_id 是 String 可视化作业ID。 表2 restart_visualization_job返回参数说明 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式1：根据部署在线服务生成的服务对象进行查询服务日志 1 2 3 4 5 6 7 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_instance = Predictor(session, service_id="your_service_id") predictor_log = predictor_instance.get_service_logs() print(predictor_log) 方式2：根据查询服务对象列表返回的服务对象进行查询服务日志 1 2 3 4 5 6 7 8 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_object_list = Predictor.get_service_object_list(session) predictor_instance = predictor_object_list[0] predictor_log = predictor_instance.get_service_logs() print(predictor_log)

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 表2 get_job_version_info返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。 job_id Long 训练作业的ID。 job_name String 训练作业的名称。 job_desc String 训练作业的描述信息。 version_count Long 训练作业的版本数。 versions JSON Array 训练作业的运行版本参数。 表3 versions属性列表 参数 参数类型 描述 version_id Long 训练作业的版本ID。 version_name String 训练作业的版本名称。 pre_version_id Long 训练作业前一版本的ID。 engine_type Long 训练作业的引擎类型。 engine_id Long 训练作业的引擎ID。 engine_version String 训练作业的引擎版本。 status Integer 训练作业的状态。 app_url String 训练作业的代码目录。 boot_file_url String 训练作业的代码启动文件。 create_time Long 训练作业的创建时间。 parameter JSON Array 训练作业的运行参数，为label-value格式；当为 自定义镜像 训练作业的时候，此参数为容器环境变量。 duration Long 训练作业的运行时间，单位为毫秒。 spec_id Long 训练作业资源规格ID。 core String 资源规格的核数。 cpu String 资源规格CPU内存。 gpu_num Integer 资源规格GPU的个数。 gpu_type String 资源规格GPU的类型。 worker_server_num Integer 训练作业worker的个数。 data_url String 训练作业的数据集。 train_url String 训练作业输出文件OBS路径。 log_url String 训练作业的日志OBS输出路径URL，默认为空。如：“/usr/log/”。 dataset_version_id String 训练作业的数据集版本ID。 dataset_id String 训练作业的数据集ID。 data_source JSON Array 训练作业使用的多数据集。 model_id String 训练作业的模型ID。 model_metric_list JSON Array 训练作业的模型评测参数。 system_metric_list JSON Array 训练作业的系统监控指标。 user_image_url String 自定义镜像训练作业的自定义镜像的SWR-URL。 user_command String 自定义镜像训练作业的自定义镜像的容器的启动命令。 表4 data_source属性列表 参数 参数类型 描述 dataset_id String 训练作业的数据集ID。 dataset_version String 训练作业的数据集版本ID。 type String 数据集类型。 “obs”：表示使用OBS的数据。 “dataset”：表示使用数据集的数据。 data_url String OBS的桶路径。 表5 model_metric_list属性列表 参数 参数类型 描述 metric JSON Array 训练作业的模型单个分类测评参数。 total_metric JSON Array 训练作业的模型总测评参数。 表6 system_metric_list属性列表 参数 参数类型 描述 cpuUsage JSON Array 训练作业CPU资源占用率。 memUsage JSON Array 训练作业内存资源占用率。 gpuUtil JSON Array 训练作业GPU资源占用率。 表7 metric属性列表 参数 参数类型 描述 metric_values JSON Array 训练作业模型单个分类测评参数指标。 reserved_data JSON Array 预留字段。 metric_meta JSON Array 训练作业模型单个分类，包含类ID和类名。 表8 metric_values属性列表 参数 参数类型 描述 recall JSON Array 训练作业模型单个分类召回率。 precision JSON Array 训练作业模型单个分类精确率。 accuracy JSON Array 训练作业模型单个分类准确率。 表9 total_metric属性列表 参数 参数类型 描述 total_metric_meta JSON Array 预留字段。 total_reserved_data JSON Array 预留字段。 total_metric_values JSON Array 训练作业模型总测评参数指标。 表10 total_metric_values属性列表 参数 参数类型 描述 f1_score Float 训练作业模型总召回。 recall Float 训练作业模型总召回率。 precision Float 训练作业模型总精确率。 accuracy Float 训练作业模型总准确率。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id查询 1 2 3 4 5 6 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(session, job_id="182626") job_version_info = estimator.get_job_version_info() print(job_version_info) 方式二：根据创建训练作业版本生成的训练作业版本对象查询 1 2 job_version_info = job_version_instance.get_job_version_info() print(job_version_info)

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() job_paras_list = Estimator.get_job_configs_list(modelarts_session=session, per_page=10, page=1, sort_by="create_time", order="asc", search_content="configname") print(job_paras_list)

参数说明 表1 get_job_configs_list请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 per_page 否 Integer 指定每一页展示作业参数的总量，默认为10，“per_page”可选的范围为[1，1000]。 page 否 Integer 指定要查询页的索引，默认为1。 sortBy/sort_by 否 String 当使用AK/SK认证方式时，参数名为sortBy；当使用帐户认证方式时，参数名为sort_by。指定查询的排序方式，默认是作业名称“job_name”，目前支持的排序还有作业描述“job_desc”，作业状态“status”，运行时长“duration”，引擎类型“engine_type”以及创建时间 “create_time”。 order 否 String 可选值有： “asc”为递增排序，默认为“asc”。 “desc”为递减排序。 search_content 否 String 指定要查询的文字信息，例如参数名称。默认为空。 表2 get_job_configs_list返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 config_total_count Integer 查询到的训练作业参数的总数。 configs JSON Array configs参数属性列表。 is_success Boolean 调用是否成功。 表3 configs属性列表说明 参数 参数类型 描述 config_name String 训练作业参数的名称。 config_desc String 训练作业参数的描述信息。 create_time Long 训练作业的创建时间。 engine_type Short 训练作业的引擎类型。 engine_name String 训练作业的引擎名称。 engine_id Long 训练作业的引擎ID。 engine_version String 训练作业使用的引擎版本。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式1：根据部署在线服务生成的服务对象删除服务 1 2 3 4 5 6 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_instance = Predictor(session, service_id="your_service_id") predictor_instance.delete_service() 方式2：根据查询服务对象列表返回的服务对象删除服务 1 2 3 4 5 6 7 from modelarts.session import Session from modelarts.model import Predictor session = Session() predictor_object_list = Predictor.get_service_object_list(session) predictor_instance = predictor_object_list[0] predictor_instance.delete_service()

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 version_id 是 String 训练作业的版本ID。version_id可通过查询训练作业版本列表的响应获取。 表2 delete_job_version返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id和version_id删除 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(session, job_id="182626", version_id="278813") status = estimator.delete_job_version() 方式二：根据创建训练作业版本生成的训练作业版本对象删除 1 status = job_version_instance.delete_job_version() 方式三：根据查询训练作业版本列表返回的指定训练作业版本对象删除 1 status = job_version_instance_list[0].delete_job_version()

示例代码 在ModelArts Notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 from modelarts.session import Session session = Session() # 1. 上传本地文件至OBS session.obs.copy(src_path='/home/ma-user/file1.txt', dst_path='obs://bucket-name/dir1/file1.txt') # 2. 下载OBS文件至本地 session.obs.copy(src_path='obs://bucket-name/dir1/file1.txt', dst_path='/home/ma-user/file1.txt') # 3. 上传本地文件夹至OBS session.obs.copy(src_path='/home/ma-user', dst_path='obs://bucket-name/dir1', keep_last_dir=True) # 4. 下载OBS文件夹至本地 session.obs.copy(src_path='obs://bucket-name/dir1', dst_path='/home/ma-user', keep_last_dir=True) 表1 请求参数说明 参数 是否必选 参数类型 描述 session 是 Object 会话对象。 src_path 是 String 源文件或源文件夹路径，当源路径为OBS路径时，必须以obs://作为路径前缀。 dst_path 是 String 目的文件或目的文件夹路径，当目的路径为OBS路径时，必须以obs://作为路径前缀。 keep_last_dir 否 Boolean 默认为True，复制文件夹时是否将源文件夹最后一级目录复制至目的文件夹下，仅对文件夹复制有效。 表2 失败相应说明 参数 参数类型 描述 error_code String 调用失败时的错误码。调用成功时无此字段。 error_msg String 调用失败时的错误信息。调用成功时无此字段。

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 version_id 是 String 训练作业的版本ID。version_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.version_id”。或可通过查询训练作业列表的响应获取。 表2 get_job_log请求参数说明 参数 是否必选 参数类型 描述 log_file 是 String 训练作业日志文件的文件名。 start_byte 否 Long 获取日志的起始位置，默认为0。“start_byte”限制范围为[-1, +∞]，如果设置为-1，则表示获得最新长度为“offset”的日志。 offset 否 Long 获取日志的长度，默认为2048。“offset”限制长度为[-2048, 2048]。 表3 get_job_log返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 content String 请求获得日志的内容。 lines Integer 获得日志的行数。 start_line String 该段日志内容的开始位置。 end_line String 该段日志内容的结束位置。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id和version_id查询 1 2 3 4 5 6 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, job_id="182626", version_id="278813") job_log = estimator.get_job_log(log_file='job-job-0713-191758.0') print(job_log) 方式二：根据创建训练作业生成的训练作业对象查询 1 2 job_log = job_instance.get_job_log(log_file='job-job-0713-191758.0') print(job_log) 方式三：根据查询训练作业版本列表返回的指定训练作业版本对象查询 1 2 job_log = job_version_instance_list[0].get_job_log(log_file='job-job-0713-191758.0') print(job_log)

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 train_instance_count 是 Long 训练作业worker的个数。 code_dir 否 String 训练作业的代码目录，如“/bucket/src/”。当填入model_name时不需要填写。 boot_file 否 String 训练作业的代码启动文件，需要在代码目录下，如“/bucket/src/boot.py”。当填入model_name时不需要填写。 model_name 否 Long 训练作业的内置算法模型名称。填入model_name后app_url与boot_file_url不需填写，framework_type和framework_version也不需要填写。 output_path 是 String 训练作业的输出位置。 hyperparameters 否 JSON Array 训练作业的运行参数，为label-value格式；当为自定义镜像训练作业的时候，此参数为容器环境变量。 log_url 否 String 训练作业的日志OBS输出路径URL，默认为空。如：“/usr/log/”。 train_instance_type 是 Long 训练作业选择的资源规格。若选择在训练平台训练，请从查询资源规格列表接口获取。 framework_type 否 String 训练作业选择的引擎规格。请从查询引擎规格列表接口获取引擎规格。当填入model_name时不需要填写。 framework_version 否 String 训练作业选择的引擎版本。请从查询引擎规格列表接口获取引擎版本。当填入model_name时不需要填写。 job_description 否 String 训练作业的描述。 user_image_url 否 String 自定义镜像训练作业的自定义镜像的SWR-URL。如：“100.125.5.235:20202/jobmng/custom-cpu-base:1.0”。 user_command 否 String 自定义镜像训练作业的自定义镜像的容器的启动命令。形式为：“bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}”。 表2 update_job_configs请求参数说明 参数 是否必选 参数类型 描述 config_name 是 String 训练作业参数名称。限制为1-20位只含数字、字母、下划线或者中划线的名称。当不填写时，默认会按日期动态生成。 config_desc 否 String 对训练作业的描述，默认为空，字符串的长度限制为[0，256]。 inputs 否 String 训练作业的OBS数据存储位置。 dataset_id 否 String 训练作业的数据集ID。应与dataset_version_id同时出现，但不可与inputs同时出现。 dataset_version_id 否 String 训练作业的数据集版本ID。应与dataset_id同时出现，但不可与inputs同时出现。 data_source 否 JSON Array 训练作业使用的数据集。不可与inputs、dataset_id、dataset_version_id同时使用。 表3 data_source属性列表 参数 是否必选 参数类型 描述 dataset_id 否 String 训练作业的数据集ID。 dataset_version 否 String 训练作业的数据集版本ID。 type 是 String 数据集类型。可选值：“obs”、“dataset”。 data_url 否 String obs的桶路径，不可与dataset_id/dataset_version同时出现。 表4 update_job_configs返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 示例一：使用OBS存储位置更新训练作业参数 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator( modelarts_session=session, framework_type='PyTorch', # AI引擎名称 framework_version='PyTorch-1.0.0-python3.6', # AI引擎版本 code_dir='/bucket/src/', # 训练脚本目录 boot_file='/bucket/src/pytorch_sentiment.py', # 训练启动脚本目录 log_url='/bucket/log/', # 训练日志目录 hyperparameters=[ {"label":"classes", "value": "10"}, {"label":"lr", "value": "0.001"} ], output_path='/bucket/output/', # 训练输出目录 train_instance_type='modelarts.vm.gpu.p100', # 训练环境规格 train_instance_count=1) # 训练节点个数 update_info = estimator.update_job_configs(config_name='my_job_config', inputs='/bucket/dataset/', config_desc='update') 示例二：使用数据集更新训练作业参数 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator( modelarts_session=session, framework_type='PyTorch', # AI引擎名称 framework_version='PyTorch-1.0.0-python3.6', # AI引擎版本 code_dir='/bucket/src/', # 训练脚本目录 boot_file='/bucket/src/pytorch_sentiment.py', # 训练启动脚本目录 log_url='/bucket/log/', # 训练日志目录 hyperparameters=[ {"label":"classes", "value": "10"}, {"label":"lr", "value": "0.001"} ], output_path='/bucket/output/', # 训练输出目录 train_instance_type='modelarts.vm.gpu.p100', # 训练环境规格 train_instance_count=1) # 训练节点个数 update_info = estimator.update_job_configs(config_name='my_job_config', dataset_id='4AZNvFkN7KYr5EdhFkH', dataset_version_id='UOF9BIeSGArwVt0oI6T', config_desc='update')

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数；其它平台的Session鉴权请参考Session鉴权。 方式1：根据部署在线服务生成的服务对象进行更新服务配置 1 2 3 4 5 6 7 8 9 10 from modelarts.session import Session from modelarts.model import Predictor from modelarts.config.model_config import ServiceConfig session = Session() predictor_instance = Predictor(session, service_id="your_service_id") configs = [ServiceConfig(weight="100", instance_count=1, specification="modelarts.vm.cpu.2u",model_id="your_model_id")] service_config = predictor_instance.update_service_config(description="description", status="running", configs=configs) 方式2：根据查询服务对象列表返回的服务对象进行更新服务配置 1 2 3 4 5 6 7 8 9 10 11 from modelarts.session import Session from modelarts.model import Predictor from modelarts.config.model_config import ServiceConfig session = Session() predictor_object_list = Predictor.get_service_object_list(session) predictor_instance = predictor_object_list[0] configs = [ServiceConfig(weight="100", instance_count=1, specification="modelarts.vm.cpu.2u",model_id="your_model_id")] predictor_config = predictor_instance.update_service_config(description="description", status="running", configs=configs)

参数说明 表1 部署predictor参数说明 参数 是否必选 参数类型 描述 description 否 String 服务描述，不超过100个字符，不设置此参数时，表示不更新。 status 否 String 服务状态，可设置状态为running或stopped来启动、停止服务，不设置此参数则不修改状态。status不可跟configs同时修改，同时存在则只修改status。 configs 否 包括predictor configs结构和transformer configs 服务配置，不设置此参数时，表示不更新。关于configs如何生成，请参见部署在线服务。 更新服务配置时，存在以下约束： 参数status指定的目标状态不允许和当前服务状态相同。 当前服务状态是deploying（部署中）、stopping（停止中）、deleteing（删除中）时，不允许参数status设置成running（启动）或设置参数configs（服务配置）。 当前服务状态是waiting（排队中）时，不允许参数status设置成running（启动）。 当前服务状态是concerning（告警）时，不允许参数status设置成running（启动）。

参数说明 表1 VisualizationJob请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法见Session鉴权。 visualization_id 是 String 可视化作业ID。 表2 stop_visualization_job返回参数说明 参数 参数类型 描述 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一： 根据指定的visualization_id停止 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import VisualizationJob session = Session() job = VisualizationJob(modelarts_session=session, visualization_id='8992') status = job.stop_visualization_job() 方式二： 根据创建可视化作业生成的可视化作业对象停止 1 status = job_visualization_instance.stop_visualization_job() 方式三： 根据查询可视化作业对象列表返回的指定可视化作业对象停止 1 status = job_visualization_instance_list[0].stop_visualization_job()

参数说明 表1 Estimator请求参数说明 参数 是否必选 参数类型 描述 modelarts_session 是 Object 会话对象，初始化方法请参见Session鉴权。 job_id 是 String 训练作业的ID。job_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.job_id”。或可通过查询训练作业列表的响应获取。 version_id 是 String 训练作业的版本ID。version_id可通过创建训练作业生成的训练作业对象查询，如“job_instance.version_id”。或可通过查询训练作业列表的响应获取。 表2 get_job_log_file_list返回参数说明 参数 参数类型 描述 error_msg String 调用失败时的错误信息。 调用成功时无此字段。 error_code String 调用失败时的错误码，具体请参见错误码。 调用成功时无此字段。 log_file_list List 训练作业的日志文件名。单机作业日志仅有一个文件，分布式作业日志有多个文件。 is_success Boolean 接口调用是否成功。

示例代码 在ModelArts notebook平台，Session鉴权无需输入鉴权参数。其它平台的Session鉴权请参见Session鉴权。 方式一：根据指定的job_id和version_id获取 1 2 3 4 5 from modelarts.session import Session from modelarts.estimator import Estimator session = Session() estimator = Estimator(modelarts_session=session, job_id="182626", version_id="278813") job_log_list = estimator.get_job_log_file_list() 方式二：根据创建训练作业生成的训练作业对象获取 1 job_log_list = job_instance.get_job_log_file_list() 方式三：根据查询训练作业版本列表返回的指定训练作业版本对象获取 1 job_log_list = job_version_instance_list[0].get_job_log_file_list()

步骤2：Token认证 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 在Postman界面上，单击左侧导航树“获取token”配置文件。 选中“Body”的配置项，添加华为云用户名、密码、帐号名。可在我的凭证获取这些信息。 username： IAM 用户名。 password：IAM用户密码。 domainname：帐号名。 project name：表示服务部署区域名，如在本示例中服务部署区域为cn-north-4，详细介绍请参见终端节点。 获取Token 时，如果出现账密报错The username or password is wrong，请参见常见问题解决。 图2 Token认证鉴权 单击“Send”，发送请求，获取并复制Token。 获取返回结果“Headers”中的“X-Subject-Token”即为Token。Token有效期为24小时。 图3 获取Token

错误码说明 表1 错误码 状态码 错误码 错误信息 说明 处理措施 400 IVS.0001 Request parameter meta is null or empty. 请求体参数为null或空。 请参考API文档填写请求Body信息，并检查请求body格式是否正确。 400 IVS.0002 Request parameter req_data is redundant. 请求体参数冗余，req_data的元素数量大于1。 req_data列表中当前仅支持1个元素。 400 IVS.0003 Some necessary request parameters in req_data is null. 请求参数有一些必要的参数为null。 请参考API文档填写必要的参数后重试。 400 IVS.0004 Image base64 size is more than 4MB or less than 10KB. 图像的base64数据量大于4MB或小于10KB。 要求base64编码后大小不超过4MB。图像各边的像素大小在300到8000px之间。 400 IVS.0005 Video base 64 size is more than 10MB or less than 10KB. 视频的base 64数据量大于10MB或小于10KB。 要求base 64编码后大小不超过10MB。建议客户端压缩至200KB至2MB。 400 IVS.0006 The input face image is invalid. 输入的人脸图像不合法。 要求base64编码后大小不超过4MB。图像各边的像素大小在300到4000px之间，支持JPG格式。 400 IVS.0007 Id card image error: %s. Please try another image. 输入的身份证图像错误，请换张图像重试。 请检查身份证图片是否正常，图片中文字清晰，并根据具体错误信息更换图片。 400 IVS.0008 live detect error: %s. Please check your input. 活体检测失败，请检查输入。 请检查视频是否正常，视频中的人的头部和脸部符合动作要求，并根据具体错误信息更换视频或修改动作列表。 400 IVS.0009 face detect error: %s. Please check your input. 人脸检测失败，请检查输入。 请检查人脸图片是否正常，图片中有清晰的人脸，并根据具体错误信息更换图片。 400 IVS.0010 face compare error: %s. Please check your input. 人脸比对失败，请检查输入。 请检查输入图片base64中是否包含人脸。 400 IVS.0011 The request param has wrong format, the length of %s exceeds %s bytes. The request param has wrong format, error in parsing %s, %s type expected. The request param has wrong format, %s is null or empty. The request param has wrong format, verification_name contain invalid characters. The request param has wrong format, verification_id length must equal 15 or 18. The request param has wrong format, verification_id is invalid. 请求参数格式错误，参数长度超出范围。 请求参数格式错误，解析参数出现错误。 请求参数格式错误，参数的值为null或空。 请求参数格式错误，verification_name 包含了无效字符。 请求参数格式错误，verification_id长度需为15位或18位。 请求参数格式错误，verification_id无效。 请将参数长度设置在相应范围内。 请参考API文档，修改对应参数的类型。 请检查参数名是否填写正确，以及参数名对应的值是否有填写。 请检查verification_name是否为有效的姓名。 请检查verification_id的长度。 请检查verification_id是否为有效的身份证号码。 400 IVS.0012 Lack Header or Header Content-Type is empty. 缺少请求头或请求头为空。 请参考API文档填写请求头。 400 IVS.0013 The authentication token is abnormal. Token异常。 请参考认证鉴权重新获取Token。 400 IVS.0014 The service has been frozen. 服务已冻结。 请检查是否有欠费。 400 IVS.0015 The subservice has not been subscribed. 服务未开通。 请登录控制台开通 人证核身 服务。 已开通情况下，检查服务的开通区域和调用API时，url中填写的区域是否一致。 500 IVS.0101 Service inner error. 服务内部错误。 请联系华为云支持人员。 网关错误码 错误码类别 状态码 错误码 说明 处理措施 网关类错误 （错误码区间：1～400） 404 APIG.0101 访问的API不存在或尚未在环境中发布。 请检查API的URL是否拼写正确，例如，URL中是否缺少project_id。 检查URI中的区域信息是否和调用服务配置的区域是否对应。 HTTP请求方法（POST，GET等）是否正确。 具体的URI信息请在各接口的API页面查看。 413/504 APIG.0201 请求体超过范围或者后端超时。 请检查请求的大小是否合法，请联系客服检查后端服务是否运行正常。 401 APIG.0301 IAM身份验证信息不正确： decrypt token fail：token解析失败。 token expires：token过期。 verify aksk signature fail：AK/SK认证失败。 token解析失败，请检查获取token的方法，请求体信息是否填写正确，token是否正确；检查获取token的环境与调用的环境是否一致。 token超时（token expires） ，请重新获取token，使用不过期的token。 请检查AK/SK是否正确（AK对应的SK错误，不匹配；AK/SK中多填了空格）。 AK/SK频繁出现鉴权出错，连续错误5次以上，被锁定5分钟（5分钟内，则一直认为其是异常的鉴权请求），5分钟后解锁重新认证。 检查帐号权限，是否欠费，被冻结等。 401 APIG.0307 Token需要更新 Token有效期为24小时，请使用重新获取Token调用API。 检查接口URL中的终端节点是否填写正确。部署在不同区域间的服务，不可以跨区域调用。如果调用了不同区域的接口，导致判断为Token失效，显示APIG.0307错误码。 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。