华为云用户手册

执行结果 执行结果由3部分组成：函数返回、执行摘要和日志。 表3 执行结果说明 参数项 执行成功 执行失败 函数返回 返回函数中定义的返回信息。 返回包含错误信息和错误类型的JSON文件。格式如下： { "errorMessage": "", "errorType": "" } errorMessage：Runtime返回的错误信息 errorType：错误类型 执行摘要 显示请求ID、配置内存、执行时长、实际使用内存和收费时长。 显示请求ID、配置内存、执行时长、实际使用内存和收费时长。 日志 打印函数日志，最多显示4KB的日志。 打印报错信息，最多显示4KB的日志。

函数Handler定义 ASSEMBLY::NAMESPACE.CLASSNAME::METHODNAME .ASSEMBLY为应用程序的.NET程序集文件的名称，假设文件夹名称为HelloCsharp。 NAMESPACE、CLASSNAME即入口执行函数所在的namespace和class名称。 METHODNAME即入口执行函数名称。例如： 创建函数时Handler：HelloCsharp::Example.Hello::Handler。

SDK接口 Context接口 Context类中提供了许多属性供用户使用，如表1所示。 表1 Context对象说明 属性名 属性说明 String RequestId 请求ID。 String ProjectId Project Id。 String PackageName 函数所在分组名称。 String FunctionName 函数名称。 String FunctionVersion 函数版本。 Int MemoryLimitInMb 分配的内存。 Int CpuNumber 获取函数占用的CPU资源。 String Accesskey 获取用户委托的AccessKey（有效期24小时），使用该方法需要给函数配置委托。 当前 函数工作流 已停止维护Runtime SDK 中String AccessKey接口，您将无法使用String AccessKey获取临时AK。 String Secretkey 获取用户委托的SecretKey（有效期24小时），使用该方法需要给函数配置委托。 当前函数工作流已停止维护Runtime SDK 中String SecretKey接口，您将无法使用String SecretKey获取临时SK。 String SecurityAccessKey 获取用户委托的SecurityAccessKey（有效期24小时），使用该方法需要给函数配置委托。 String SecuritySecretKey 获取用户委托的SecuritySecretKey（有效期24小时），使用该方法需要给函数配置委托。 String SecurityToken 获取用户委托的SecurityToken（有效期24小时），使用该方法需要给函数配置委托。 String Token 获取用户委托的Token（有效期24小时），使用该方法需要给函数配置委托。 Int RemainingTimeInMilliSeconds 函数剩余运行时间。 String GetUserData(string key,string defvalue=" ") 通过key获取用户通过环境变量传入的值。 日志接口 FunctionGraph中C# SDK中接口日志说明如所示。 表2 日志接口说明 方法名 方法说明 Log(string message) 利用context创建logger对象： var logger = context.Logger; logger.Log("hello CS harp runtime test(v1.0.2)"); Logf(string format, args ...interface{}) 利用context创建logger对象： var logger = context.Logger; var version = "v1.0.2" logger.Logf("hello CSharp runtime test({0})", version);

C#函数接口定义 FunctionGraph运行时目前支持C#(.NET Core 2.1)、C#(.NET Core 3.1)、C#(.NET Core 6.0)、.NET Core 8.0（仅支持“中东-利雅得”、“土耳其-伊斯坦布尔”区域）版本。 C#函数接口定义：作用域 返回参数 函数名（函数参数，Context参数） 作用域：提供给FunctionGraph调用的用户函数必须定义为public。 返回参数：用户定义，FunctionGraph负责转换为字符串，作为HTTP Response返回。 函数名：用户自定义函数名称，需要和函数执行入口处用户自定义的入口函数名称一致。 执行事件体：函数执行界面由用户输入的执行事件参数。 上下文环境（context）：Runtime提供的函数执行上下文，相关属性定义在对象说明中。 HC.Serverless.Function.Common –部署在FunctionGraph服务中的项目工程需要引入该库，其中包含IFunctionContext对象，详情见context类说明。 创建csharp函数时，需要定义某个类中的方法作为函数执行入口，该方法可以通过定义IFunctionContext类型的参数来访问当前执行函数的信息。例如： 1 2 3 4 public Stream handlerName(Stream input,IFunctionContext context) { // TODO } C#函数的函数执行入口参数格式为：[程序集名]::[命名空间].[类名]::[执行函数名]，例如CsharpDemo::CsharpDemo.Program::MyFunc，请参考函数执行入口通过FunctionGraph控制台进行配置或修改。 建议使用.NET Core 3.1版本。

入口插件 实现Entry插件。 devspore-horizon提供了抽象类Processor，用户需要继承这个抽象类，实现抽象方法doProcess(DataEvent event)，把认证和鉴权的处理逻辑写到此方法体内。此方法返回值为boolean型。如果认证或者鉴权的逻辑失败，则返回false，责任链后续节点不再执行，整个请求返回不再执行；如果认证或者鉴权成功，则返回为true，继续执行后续节点。Processor代码如下： public abstract class Processor { protected MetaDocument metaDoc; private String name; private Processor next; public Processor getNext() { return next; } public void setNext(Processor next) { this.next = next; } public boolean process(DataEvent dataEvent) throws PluginException { if (!doProcess(dataEvent)) { return false; } if (null != next) { return next.process(dataEvent); } return true; } public abstract boolean doProcess(DataEvent dataEvent) throws PluginException; public String getName() { return name; } } 填写配置信息。 完成接口实现之后，还需要填写配置信息。有关horizon的入口拦截配置信息如下： devspore.horizon.approvers 实现的Entry插件，插件必须注入到spring IOC容器，并提供bean id，赋值给devspore.horizon.processors配置项。devspore.horizon.processors配置项是个数组。horizon会读取数组中每个bean id，执行已实现的鉴权、认证等逻辑。 多个插件以","分隔，多个插件按配置顺序执行。 devspore: horizon: processors: bean1,bean2

出口插件 实现Exit插件。 devspore-horizon提供了接口Observer，用户需要实现这个接口的observe(DataEvent dataEvent)方法，把变更通知、更新缓存、统一审计、统一工作流的处理逻辑写到此方法体内即可。 Observer代码如下： public interface Observer { // receive the BO changes void observe(DataEvent dataEvent) throws PluginException; } 填写配置信息。 完成接口实现之后，还需要填写配置信息。有关horizon的出口拦截配置信息如下： devspore.horizon.observers devspore.horizon.observers配置项也是个数组。horizon会读取数组中每个bean id，执行已实现的消息发送、审计等逻辑。 多个插件以","分隔，多个插件按配置顺序执行。 devspore: horizon: observers: bean1,bean2

内置插件 开启horizon后，会自动生成两个内置插件，用户在插件中实现统一的操作前认证、鉴权，操作后消息发送、缓存更新、审计等逻辑即可： Entry插件 /** * default request plugin */ @Component @javax.annotation.Generated(value = "com.huaweicloud.devspore.codegen, xxx-RELEASE") public class DefaultRequestPlugin extends Processor { @Override public boolean doProcess(DataEvent dataEvent) throws PluginException { // do your code return true; } } Exit插件 /** * default response plugin */ @Component @javax.annotation.Generated(value = "com.huaweicloud.devspore.codegen, xxx-RELEASE") public class DefaultResponsePlugin implements Observer { @Override public void observe(DataEvent dataEvent) throws PluginException { // do your code } } 配置文件 devspore: horizon: processors: defaultRequestPlugin observers: defaultResponsePlugin

devspore-probe常用的配置参数如下所示 devspore: probe: metrics: tags: component: devspore-application # 应用名称，使监控指标带上应用标签 api-description-tags: false # 是否开启http_server_request指标添加description标签功能 aom: enable: false # 是否开启监控数据上报 AOM 平台功能 authentication：AccessCode # 监控数据上报AOM的鉴权方式，可选值：AccessCode，AccessKey ak: ${aom_ak} # 用户AK sk: ${aom_sk} # 用户SK url: ${aom_url} # 监控数据上报AOM平台接口URL access-code：${aom_accessCode} # 选择AccessCode配置 push-interval-seconds: 60 # 监控数据上报AOM平台的采集间隔，单位：秒 pattern: # 符合该正则表达式的监控项将被上报到AOM，默认上报所有的监控项 external-env-info: false # 是否在监控数据中加入serviceStage环境变量 batch-size：60 # 每批次上传AOM平台的Body包包含的监控项数量，默认值60

参数说明 表1 参数说明 参数名称 默认值 类型 被监控组件或应用名称 devspore.probe.metrics.tags.component - String 被监控组件或应用名称。 devspore.probe.metrics.api-description-tags false boolean 是否开启http_server_request指标添加description标签功能，如开启，会自动添加@ApiOperation注解的value字段或@Operation注解的summary字段作为description值。 devspore.probe.aom.enable false boolean 是否开启监控数据上报AOM平台功能。 devspore.probe.aom.authentication - String 监控数据上报AOM的鉴权方式，可选值：AccessCode，AccessKey。 当选择AccessCode时，url、access-code必须配置。 当选择AccessKey时，url、ak、sk必须配置。 devspore.probe.aom.ak - String 用户AK。 devspore.probe.aom.sk - String 用户SK。 devspore.probe.aom.access-code - String 用户AccessCode。 devspore.probe.aom.apig-app-code - String 被授权服务的appCode、非必须使用，非内部用户使用AccessCode鉴权方式的时候需要配置此配置。 devspore.probe.aom.url - String 监控数据上报AOM平台接口URL。 devspore.probe.aom.push-interval-seconds 60 int 监控数据上报AOM平台的采集间隔，单位：秒。 devspore.probe.aom.pattern /w* String 符合该正则表达式的监控项将被上报到AOM，默认上报所有的监控项。 devspore.probe.aom.external-env-info false boolean 是否在监控数据中加入serviceStage环境变量。 devspore.probe.aom.batch-size false int 每批次上传AOM平台的Body包包含的监控项数量，默认值60。

request日志字段说明 表1 request日志字段说明 字段名 字段含义 可选/必选 logType 日志类型 必选，值固定为request url 请求URL 必选 path 请求路径 必选 method 请求HTTP方法 必选 status 返回状态码 必选 startTime 请求开始时间 必选 duration 请求时长 必选 clientIp 请求方IP 必选 clientType 客户端类型 必选 userId 请求所属用户ID 必选 reqBodySize 请求体body大小 必选 resBodySize 返回体body大小 必选 nenvId 调用方服务 APM 环境ID 必选（依赖APM） senvId 被调用服务APM环境ID 必选（依赖APM） tracId 调用链跟踪ID 必选（依赖APM）

实现原理 devspore-http-log打印请求日志是通过实现常见HTTP请求客户端的拦截器来完成的。拦截器可以在请求发送之前和响应返回之后对数据进行处理，从而实现日志记录。 例如，在Spring Boot中，可以通过实现ClientHttpRequestInterceptor接口并重写intercept方法来创建自定义拦截器。在拦截器中，可以添加日志记录逻辑，以打印请求和响应的详细信息。此外，还可以通过RestTemplateCustomizer将自定义拦截器注册到RestTemplate中，从而实现对HTTP请求和响应的全局日志记录。 这种实现方式的优点是通用性强、代码侵入性小，并且具有可定制性。通过拦截器，可以在不修改业务逻辑代码的情况下，轻松地添加日志记录功能。 目前支持的客户端有：httpclient、okhttp、RestTemplate和Feign。

使用方式 HttpClient 前提：需要使用httpclient进行对第三方的调用。 需要用户在创建CloseableHttpClient时添加com.huaweicloud.devspore.http.log.httpclient.HttpClientRequestInterceptor和com.huaweicloud.devspore.http.log.httpclient.HttpClientReponseInterceptor。 示例： CloseableHttpClient httpClient = HttpClients.custom() .addInterceptorFirst(new HttpClientRequestInterceptor()) .addInterceptorFirst(new HttpClientResponseInterceptor()) .build(); OkHttp 前提：需要使用okhttp进行对第三方的调用。 需要用户在创建OKhttpclient时添加com.huaweicloud.devspore.http.log.okhttp.OkhttpInterceptor。 示例： OkHttpClient okHttpClient = new OkHttpClient.Builder().addInterceptor(new OkhttpInterceptor()).build(); RestTemplate 注意：若存在使用restTemplate传输大文件或者大对象的场景，请不要使用此拦截器记录requestLog，否则极有可能引入OOM问题。 前提：需要使用restTemplate进行对第三方的调用。 以bean形式注入的restTemplate。 需要在spring配置文件中添加配置项：devspore.http-log.request.rest-template.enable=true。 当devspore.http-log.request.enable(默认值true)和devspore.http-log.request.rest-template.enable(默认值false)两个配置项同时为true时，才会自动添加RestTemplateInterceptor。 原理：当配置条件允许使用RestTemplateInterceptor时，httplog组件会扫描服务中所有的RestTemplate类型的bean，并为其添加RestTemplateInterceptor拦截器。 相关源码见：com.huaweicloud.devspore.http.log.config.DevsporeHttpLogAutoConfiguration.setApplicationContext() 非bean形式注入的restTemplate。 需要用户在创建restTemplate时添加com.huaweicloud.devspore.http.log.resttemplate.RestTemplateInterceptor。 RestTemplate restTemplate = new RestTemplate(); restTemplate.getInterceptors().add(0, new RestTemplateInterceptor()); Feign 前提：需要使用Feign Client进行对第三方的调用。 当使用Feign的时候，无需做其他改动，devspore-http-log会自动打印request日志，如不想打印request日志，可以在spring配置文件中添加配置：devspore.http-log.request.enable=false来关闭request日志的打印。

request日志示例 "nenvId": "null", "userId": "null", "url": "http://localhost:8081/servicecall/consumer/001", "path": "/servicecall/consumer/001", "method": "GET", "senvId": null, "status": 200, "tracId": null, "startTime": "2023-12-28 16:59:41.218", "duration": 33, "clientType": "httpClient.HttpResponseProxy", "clientIp": "169.254.174.247", "reqBodySize": 0, "resBodySize": 93, "logType": "request" }

数据准备 此处需要提前准备示例使用的数据库表，并初始化一些软删除功能示例使用的测试数据，具体的建表语句如下： CREATE TABLE `t_order` ( `id` varchar(40) NOT NULL COMMENT 'id', `name` varchar(200) NOT NULL, `soft_delete_flag` bigint(0) NOT NULL DEFAULT '0' COMMENT '软删除标记字段,为时间戳表示此数据执行了软删除操作,时间戳记录了软删除的时间,为0表示没有执行软删除操作;searchable', PRIMARY KEY (`id`) ) COMMENT = 'primaryKeyType("UUID")'; INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('1', 'test1', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('2', 'test2', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('3', 'test3', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('4', 'test4', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('5', 'test5', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('6', 'test6', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('7', 'test7', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('8', 'test8', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('9', 'test9', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('10', 'test10', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('11', 'test11', 0); INSERT INTO `softdelete`.`t_order`(`id`, `name`, `soft_delete_flag`) VALUES ('12', 'test12', 0);

原理 AstroPro实现多租隔离的方式是通过在需要做资源隔离的对象上额外生成一个tenant_id的字段来存储租户信息，在用户访问接口时，将调用者的租户信息存放在线程变量中（存放方式在用户自定义租户id获取接口中详细说明），通过对比线程中的租户信息和对象中的租户信息是否一致来实现租户隔离的。 用户需要在业务代码中添加租户相关的校验逻辑，具体逻辑如下： 新增时：需要在业务代码中将tenant_id设置到新增对象中。 查询时：先查出数据，再判断查出对象的tenant_id值是否和当前线程tenant_id匹配，只有匹配时才返回，不匹配时证明操作的不是当前租户的资源，此次请求不合法，抛出异常。 修改、删除时：先查出数据，再判断查出对象的tenant_id值是否和当前线程tenant_id匹配，只有匹配后才进行后续的修改或删除操作。 在生成用户自定义租户id获取接口代码时，以上相关的逻辑都会生成出来，用户在做后续的业务代码编写中应注意不要删除相关的代码。此外在自定义API中如涉及以上场景，用户需要手动添加相关校验逻辑。

access日志示例 "logType": "access", "traceId": null, "nenvId": null, "method": "GET", "resBodySize": 93, "params": null, "userId": null, "url": "http://localhost:8081/servicecall/consumer/001", "duration": 90, "path": "/consumer/{consumer_id}", "senvId": null, "service": "servicecall", "clientIp": "127.0.0.1", "appId": null, "startTime": "2023-12-25 09:33:30.589", "reqBodySize": -1, "status": 200 }

access日志字段说明 表1 access日志字段说明 字段名 字段含义 可选/必选 对应配置参数 logType 日志类型 必选，值固定为 access 无 service 微服务名称 必选，通过配置文件配置 devspore.http-log.service-name serviceAppId 微服务的AppID 必选，通过配置文件配置 devspore.http-log.service-app-id nenvId 调用方服务APM环境ID 必选 无 senvId Server端APM环境ID 必选 无 url 请求URL 必选 无 path 请求路径(去参数可聚合统计) 必选 无 method 请求HTTP方法 必选 无 params 请求参数 可选，默认值为null devspore.http-log.params reqBodySize 请求体body大小 必选 无 resBodySize 返回体body大小 必选 无 appId HIS网关appId 必选 devspore.http-log.app-id-key status 返回状态码 必选 无 traceId 调用链跟踪ID 必选 无 startTime 请求开始时间 必选 无 duration 请求时长 必选 无 clientIp 请求方IP 必选 无 userId 请求所属用户ID 必选 无 olcDryRun 是否开启olc干跑 可选 devspore.http-log.olc olcBlockMsg olc限流信息 可选 devspore.http-log.olc subToken 截断token 可选 devspore.http-log.sub-token cpuCost 当前请求所占用的cpu时间-单位（纳秒） 可选 devspore.http-log.access.resource-cost memCost 当前请求使用的内存-单位byte 可选 devspore.http-log.access.resource-cost sqlReadRows 当前请求共查询了多少行数据库记录 可选 devspore.http-log.access.sql-rows sqlAffectedRows 当前请求共影响了多少行数据库记录 可选 devspore.http-log.access.sql-rows

依赖情况 以下为本组件的具体依赖情况： com.huaweicloud.devspore:swagger-extension 表1 swagger-extension组件依赖 依赖组件 版本 scope org.projectlombok:lombok 1.18.32 compile com.huaweicloud.devspore:swagger-extension-springfox 表2 swagger-extension-springfox组件依赖 依赖组件 版本 scope org.springframework:spring-context 5.3.39 provided com.huaweicloud.devspore:swagger-extension ${devspore-swagger-extension.version} compile org.springframework.boot:spring-boot-autoconfigure 2.7.18 provided org.springframework.boot:spring-boot-configuration-processor 2.7.18 optional org.springframework:spring-webmvc 5.3.39 provided io.springfox:springfox-core 3.0.0 provided io.springfox:springfox-swagger2 3.0.0 provided io.springfox:springfox-spi 3.0.0 provided io.springfox:springfox-schema 3.0.0 provided org.mapstruct:mapstruct 1.5.5.Final provided 父主题： devspore-swagger-extension使用指南

使用说明 在编辑服务时，业务设计界面选中需要进行软删除的对象，勾选软删除策略和恢复软删除后生成代码，如下所示： 图1 设置软删除策略 当勾选了“软删除策略”后，生成的代码会有如下变化： 在勾选软删除策略的对象上会额外生成一个字段 （`soft_delete_flag` bigint(20) NOT NULL DEFAULT '0'）。 删除和批量删除的API上会额外生成一个Boolean类型的参数hardDeletion，在调用删除相关API时，如果hardDeletion传入true则进行物理删除，否则进行逻辑删除。 查询API上会额外生成一个Boolean类型的参数softDeleted，当不传入softDeleted或softDeleted传入false的时候，只查询未被删除数据（soft_delete_flag = 0 的数据）。当softDeleted参数为true时，查询将仅基于主键进行，忽略soft_delete_flag的值。 批量查询API中soft_delete_flag字段会作为一个非必填的参数添加到请求参数中。 当勾选了“恢复软删除”后，生成的代码会有如下变化： 额外生成两个API，一个是单条数据的恢复软删除（将被删除的数据的soft_delete_flag重新设置为0），一个是批量数据的恢复软删除。

method日志字段说明 表1 method日志字段说明 字段名 字段含义 可选/必选 logType 日志类型。 必选，值固定为methodLog serviceName 服务名称：取配置文件中：devspore.http-log.service-name的值。 必选 className 方法所在类的全路径限定名。 必选 methodName 方法名称。 必选 exceptionClass 方法异常后异常类全路径限定名（包名使用首字母缩写），方法无异常时此字段为null。 必选 startTime 方法开始调用时间。 必选 duration 方法耗时（单位：ms）。 必选 traceId 调用链跟踪ID。 必选（依赖APM）

method日志示例 "duration": 199, "logType": "methodLog", "methodName": "getConsumerByRestTemplate", "startTime": "2023-12-28 15:23:44.646", "className": "com.huaweicloud.service.impl.HttpLogServiceImpl", "exceptionClass": "", "serviceName": "httplogtest"， "user": "my-custom-field" }

使用方式 在spring的配置文件中添加以下配置，无需改动代码： devspore: http-log: method-level: #为true时打印methodLog，为false时不打印 enable: true #此参数控制在哪些方法上打印methodLog，使用aop切面表达式的语法 execution: '(@within(org.springframework.stereotype.Service)' #需要在methodLog中添加自定义字段时需添加如下配置 custom-fields: # user：为methodLog中添加的自定义字段名称，x-user为请求头中的key值，devspore-http-log会去请求头中获取该值打印在methodLog中 user: x-user

推理服务相关操作 在“推理服务”列表，可对任务进行以下操作。 表1 推理服务相关操作 任务 操作步骤 编辑服务 单击操作栏中的“编辑”，打开编辑推理服务弹出框，修改推理服务配置后，单击“确认”。不支持修改服务的名称和模型仓库，当修改了模型版本、资源规格、实例数和环境变量后，根据编辑前的状态，推理服务会重新构建或重新排队，期间服务将不可用。 启动服务 单击操作栏中的“启动”，可以启动服务，在启动服务时，支持重新设置“是否自动停止”配置和自动停止时间。 状态为部署失败或已停止的推理服务才能进行启动操作。 停止服务 单击操作栏中的“停止”，可以停止服务，推理服务停止后再启动将重新构建或排队，请谨慎操作。 状态为构建失败、部署失败、已停止或停止中的推理服务不能进行停止操作。 删除服务 单击操作栏中的“删除”，可以删除服务，推理服务删除后无法恢复，请谨慎操作。 查询服务 在搜索输入框中输入搜索条件，按回车键即可查询。 查看服务详情 单击服务名称，可在服务详情页查看推理服务详情、监控、事件、日志等信息。 推理服务详情：展示ID、状态、模型及版本、镜像、环境变量、资源池、资源规格、实例数、公网地址等信息。其中，公网地址将在服务部署成功后展示。属于私密信息，请勿轻易泄露。 监控：展示AI应用调用次数统计和实时资源统计信息。 事件：展示当前服务使用过程中的关键操作，比如服务构建进度、部署进度、部署异常的原因、服务被启动、停止、更新的时间点等。 日志：展示当前服务的日志信息。支持查询日志，包含最近5分钟、最近30分钟、最近1小时和自定义时间段（自定义时间段您可以选择开始时间和结束时间）。支持输入关键字搜索服务日志。 推理服务各状态允许的操作如下: 表2 推理服务各状态允许的操作 状态 编辑 启动 停止 删除 导入中 - - √ √ 构建中 - - √ √ 构建失败 √ - - √ 排队中 √ - √ √ 部署中 - - √ √ 运行中 √ - √ √ 部署失败 √ √ - √ 告警 √ - √ √ 停止中 - - - √ 已停止 √ √ - √

接口访问和调用 获取用户Token。 调用推理服务接口时首先需要获取 IAM 子用户Token作为凭据，具体参见获取IAM用户Token（使用密码）。请求示例如下： 请求URI： POST https://iam.myhuaweicloud.com/v3/auth/tokens?nocatalog=true 请求体： { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "user_name", "password": "user_password", "domain": { "name": "domain_name" } } } }, "scope": { "project": { "id": "project_id" } } } } 其中，user_name、domain_name、project_id字段可以从“我的凭证”中获取。 图1 获取参数值 请求成功（状态码201）后，从响应的Header中拿到x-subject-token的值即为Token的值。 获取的Token的有效期为24小时。建议进行缓存，避免频繁调用。 获取访问地址。 访问地址为 {公网地址} /{自定义镜像中的API地址}，例如：https://xxx/v1/infers/xxx/2d-scenario-identification。 公网地址可以从推理服务列表或者服务详情中获取。 图2 列表获取公网地址 图3 详情获取公网地址 调用推理服务。 请携带Token调用推理服务。

批次任务相关操作 单击项目名称，在“批次任务列表”，还可以进行以下操作。 表2 批次任务相关操作 任务 操作步骤 查询批次任务 在批次任务列表搜索框中，可通过任务名称、规范，任务状态和任务类型查询任务。 导出批次任务列表 单击页面的“导出”，可按需选择导出项，可将当前页面的所有标注任务导出至本地，以Excel形式查看。 导出任务 单击操作栏中的“导出数据集”，可创建导出任务。 导出单个批次任务 单击操作栏中的“导出任务列表”项目名称，可按需选择导出项，导出单个批次任务中拆分的任务。 拆分批次任务 单击操作栏中的“拆分”，即可对任务做拆分处理。具体步骤参考批次任务列表。 查看批次任务日志 单击操作栏中的“日志”，即可查看批次任务日志。 删除批次任务 选择批次任务单击“删除批次任务”，即可删除批次任务。 说明： 如果批次任务被拆分成子任务，则需要删除子任务后，才可删除批次任务。

构建镜像 Octopus平台依赖算子镜像内的/bin/bash、stdbuf、tee软件，请确保基础镜像内包含上述软件且能通过PATH找到。 Dockerfile示例。 FROM ros:noetic COPY ros_to_dataset.py /home/main/ # 算法启动示例： # python3 /home/main/ros_to_dataset.py --topic pandar --type pcd RUN apt install ros-noetic-cv-bridge python3-pcl libpcl-dev USER root 构建镜像。 运行命令： docker build -f Dockerfile -t ros-to-dataset:0.1 本地调试。 准备一个待处理的rosbag，如~/data/20220620.bag，运行如下命令（基于上述示例镜像）： docker run -v ${HOME}/data/20220620.bag:/tmp/data/20220620.bag -v ${HOME}/tmp/output:/tmp/output --env output_dir=/tmp/output --env rosbag_path=/tmp/data/20220620.bag --env tmp_dir=/tmp/workspace ros-to-dataset:0.1 /bin/sh -c “python3 /home/main/ros_to_dataset.py --topic pandar --type pcd” 完成后在${HOME}/tmp/output目录查看运行结果文件： 图6 运行结果

作业输入输出规范 Input 平台会以环境变量的形式提供以下参数： rosbag_path： 数据包路径，如果输入数据源是多个，以','分隔。示例：/tmp/DPK0000001/packageName1,/tmp/DPK0000002/packageName2。 output_dir：最终输出数据集路径。 tmp_dir：供用户存储临时文件的目录。 task_content_json：人工打标需要的标签信息，详细参考“人工打标支持”。（如果没有人工打标，不需要此参数）。 Output 对于output_dir的格式限定如下： 必须有output_dir/dataset目录，存储数据集文件。数据集文件有格式要求（Octopus、PascalVOC...）。 必须有_SUC CES S或 _FAILURE文件，标志用户镜像任务完成（或失败）。 可选有output_dir/auxiliary目录，用于存储附加文件。对格式没有限制。 图1 output_dir的格式 人工打标支持 Input 程序必须能接受task_content_json，该参数以环境变量的形式引入镜像。task_content_json格式为List of Tags。 如果没有tag，为空list。如果只有一个标签，list内只有一个Tag。 如果start与end一致，代表单帧打标。 图2 每个Tag格式示例 图3 task_content_json示例

上传数据包 获取传输配置。 在订单的“操作”列单击“获取传输配置”，获取传输配置，包括目标桶、导入目录、访问密钥 (AK)和私有访问密钥 (SK)。 准备待脱敏的数据包。 图商采集的数据在上传至八爪鱼平台前，需要对数据包中的文件夹梳理，便于脱敏识别，目录层级需为“根目录/数据存放文件夹”，根目录需为3创建的订单号。 上传至八爪鱼平台后数据路径：data/import-expresses/根目录/数据存放文件夹 例如：data/import-expresses/24/packge-1 24：根目录，即3创建的订单号。 packge-1：需要脱敏的数据存放文件夹。订单号和实际需要脱敏的文件夹之间不需要再加层级。 脱敏任务完成后平台存储的原始数据和脱敏后数据路径如下： 原始数据：data/import-expresses/24/packge-1-bak 脱敏后数据：data/import-expresses/24/packge-1 上传待脱敏的数据包。 在DES数据快递服务创建递送订单，并完成递送订单。DES订单上传源数据需要包含必要的有效文件，具体可参考上传数据格式。 数据上传完成后，单击“确认递送完成”，单击“确定”。

延时评测 仿真器输出的仿真过程数据会按照OSI的GroundTruth格式存储为pb文件，根据创建任务配置时是否选择使用datahub，该仿真pb有两种格式： 使用datahub时，该仿真pb的每帧数据是GroundTruth结构，然后按照OSI标准推荐的存储格式，先按小端顺序存储4个字节，该4个字节表示下一帧GroundTruth总的字节数，然后继续4个字节，更下一帧GroundTruth的字节数，以此类推。 未使用datahub时，该仿真pb按照sim_osi.proto定义的格式进行存储，所有仿真数据帧GroundTruth存储到一个列表字段“frames”中。 仿真平台定义了sim_osi.proto和eva.proto，用于支持用户自定义评测的功能，具体的proto字段说明见请联系接口人获取仿真服务的proto协议。

扩容资源费用 扩展资源费用是指使用Octopus时需额外购买的仿真扩展包、增强计算资源和存储扩容资源等产生的费用。除服务中自带的资源外，用户可增量购买扩容资源，提高计算性能和扩容存储空间。 表2 扩容资源计费项说明 计费项 计费子项 计费模式 计费说明 计费公式 存储扩容包 自动驾驶数据管理缓存扩容包 包年/包月 使用弹性文件服务（SFS）缓存文件，产生的费用。 规格单价 * 购买时长 * 套 自动驾驶数据管理存储扩容包 使用 对象存储服务 （OBS）存储数据和模型，产生的费用。 通用处理节点 octopus计算型CPU(16u32g)专属实例 增强计算性能，产生的费用。 octopus计算型CPU(64u128g)专属实例 AI处理节点 octopus计算型GPU(ant0324g24u96g)专属实例 octopus.hp.s2 octopus.bm.npu.arm.8snt9b3 octopus.bm.npu.arm.8snt9b1 仿真服务扩容包 规控仿真引擎-在线 购买在线仿真器，产生的费用。 感知规控仿真引擎-在线 仿真场景编辑器 规控仿真引擎-并行 增加并行任务数，产生的费用。