参数 参数 描述 n LUNNAME 或 name LUNNAME 设置卷名称。 取值：字符串形式，长度范围是1~16，只能由字母、数字和短横线（）组成，字母区分大小写，且仅支持以字母或数字开头。 p CAPACITY 或 capacity CAPACITY 设置卷容量。 取值：整数形式，数字后面可以输入单位简写G/g、T/t或P/p，分别代表GiB、TiB、PiB，如果不输入，默认为GiB。 如果单位是GiB，取值为[1, 1048576]。 如果单位是TiB，取值为[1, 1024]。 如果单位是PiB，取值为1。 t TARGETNAME 或 target TARGETNAME 指定iSCSI Target名称。 取值：字符串形式，长度范围1~16，只能由小写字母、数字、句点(.)和短横线()组成，且仅支持以字母或数字开头。 说明 创建卷时，如果指定的iSCSI Target名称不存在，那么同时创建iSCSI Target，新创建iSCSI Target的回收策略默认为Delete。 priority SERVERID & 指定卷主备分布优先级的服务器ID（仅集群版支持），系统会根据指定的服务器ID顺序来选择卷的主备IQN。可以指定一个或者多个服务器ID，以英文逗号分开。 前置条件：iSCSI Target名称已经存在，且指定的服务器必须是iSCSI Target所在的服务器。 autofailback AUTOFAILBACK 是否根据指定的卷主备分布优先级自动进行主备切换（仅集群版支持），即针对卷主备状态，当高优先级的服务器恢复正常后，是否自动进行主备状态切换。 取值： Enabled：自动进行主备切换。 Disabled：不自动进行主备切换。 默认值为Enabled。 pool POOL 指定存储池（仅集群版支持），表示最终存储池，卷数据最终落在该存储池内。默认使用集群的基础存储池。 cachepool CACHEPOOL 指定缓存存储池（仅集群版支持）。如果指定了缓存存储池，卷数据首先写入缓存存储池，然后再存入存储池。 注意 存储池与缓存存储池不能是同一个存储池。 a HIGHAVAILABILITY 或 ha HIGHAVAILABILITY 选择卷的高可用类型（仅集群版支持）： 取值： ActiveStandby（as）：启用主备，该卷关联对应Target下的所有IQN。 Disabled（off）：不启用主备，该卷关联对应Target下的1个IQN。客户端连接该类型的卷的方法可以参见Windows 客户端–单机版、Linux 客户端 – 单机版。 默认值为ActiveStandby（as）。 c LOCALSTORAGECLASS 或 localstorageclass LOCALSTORAGECLASS 卷冗余模式（仅集群版支持）。 取值： singlecopy：单副本。 2copy：两副本。 3copy：三副本。 EC N+M：纠删码模式。其中N、M为正整数，N≥M，且N+M≤128。表示将数据分割成N个片段，并生成M个校验数据。 默认值为EC 2+1。 说明 以下场景均为集群可用的前提下： 创建EC N+M的卷后： 卷所在存储池可用故障域数量大于等于卷的最小副本数时，可以向卷中写数据。卷所在存储池可用故障域数量小于最小副本数时，不能向卷写数据，且系统会产生告警。 卷所在存储池可用故障域数量大于等于N+M，卷数据正常，不会产生降级。卷所在存储池可用故障域数量处于[N, N+M），卷数据将处于降级状态，建议尽快添加或修复故障域。卷所在存储池可用故障域数量小于N时，已写入的数据发生损毁。 创建副本模式的卷后： 卷所在存储池可用故障域数量大于等于卷的最小副本数时，可以向卷中写数据。卷所在存储池可用故障域数量小于最小副本数时，不能向卷写数据，且系统会产生告警。 卷所在存储池可用故障域数量大于等于副本数，卷数据正常，不会产生降级。对于两副本、三副本卷，卷存储池所在故障域大于等于1，但小于副本数时，卷数据将处于降级状态，建议尽快添加或修复存储池故障域。卷所在存储池无可用故障域时，已写入的数据发生损毁。 minreplica MINREPLICA 最小副本数（仅集群版支持）。 对于副本模式的卷，假设卷副本数为X，最小副本数为Y（Y必须≤X），该卷每次写入时，至少Y份数据写入成功，才视为本次写入成功。对于EC N+M模式的卷，假设该卷最小副本数设置为Y（必须满足N≤Y≤N+M），必须满足总和至少为Y的数据块和校验块写入成功，才视为本次写入成功。 取值：整数。对于副本卷，取值范围是[1, N]，N为副本模式卷的副本数，默认值为1。对于EC卷，取值范围是[N, N+M]，默认值为N。 redundancyoverlap REDUNDANCYOVERLAP 指定卷的折叠副本数（仅集群版支持）。在数据冗余模式下，同一份数据的不同副本/分片默认分布在不同的故障域，当故障域损坏时，允许根据卷的冗余折叠原则，将多份数据副本放在同一个故障域中，但是分布在不同的path上。 注意 如果存储池故障域级别为path，此参数不生效。 取值：整数。对于副本卷，取值范围是[1, N]，N为副本模式卷的副本数，默认值为1；对于EC模式，取值范围是[1, N+M]，默认值为1。 ecfragmentsize ECFRAGEMENTSIZE 纠删码模式分片大小。卷冗余模式为EC模式时，此设置才生效，否则忽略。 取值：1、2、4、8、16、32、64、128、256、512、1024、2048、4096，单位是KiB。默认值为16。 o SECTORSIZE 或 sectorsize SECTORSIZE 设置扇区大小。 取值：512、4096，单位是bytes。默认值为4096。 说明 扇区大小的选取：根据自身业务场景，一般情况下，单次I/O操作的数据大小大于或接近4 KiB，则推荐选择4096；单次I/O操作的数据大小接近512 bytes，则推荐选择512。如果对接VMware等虚拟化平台，则推荐选择512 bytes。 w WRITEPOLICY 或 writepolicy WRITEPOLICY 卷的写策略： WriteBack（wb）：回写，指数据写入到内存后即返回客户端成功，之后再异步写入磁盘。适用于对性能要求较高，稳定性要求不高的场景。 WriteThrough（wt）：透写，指数据同时写入内存和磁盘，并在都写成功后再返回客户端成功。适用于稳定性要求较高，写性能要求不高，且最近写入的数据会较快被读取的场景。 WriteAround（wa）：绕写，指数据直接写到磁盘，不写入内存。适用于稳定性要求较高，性能要求不高，且写多读少的场景。 默认值为WriteBack（wb）。 P PATH 或 path PATH 指定存储卷数据的数据目录（仅单机版支持）。 取值：只能包含字母、数字、汉字和特殊字符(~ ! @ $ ( ) + ; . :)。 如果创建卷时不指定数据目录，使用服务器设置的默认数据目录。 m STORAGEMODE 或 mode STORAGEMODE 设置卷的存储类型： Local：本地模式，数据全部保留在本地。 Cache：缓存模式，本地保留部分热数据，全部数据异步存储到OOS中。 Storage：存储模式，本地保留全部数据，并异步存储到OOS中。 存储类型默认为Local。 cloudprovider CLOUDPROVIDER 对象存储服务名称： OOS：天翼云对象存储经典版I型。 S3：兼容S3的其他对象存储。 默认值为OOS。 B BUCKETNAME 或 bucket BUCKETNAME 已存在的存储桶的名称。 注意 请勿开启Bucket的生命周期设定和合规保留。 A ACCESSKEY 或 ak ACCESSKEY 对象存储服务的AccessKeyID。 S SECRETKEY 或 sk SECRETKEY 对象存储服务的SecretAccessKey。 C CLOUDSTORAGECLASS 或 cloudstorageclass CLOUDSTORAGECLASS 设置数据在对象存储的存储类型： STANDARD：标准存储。 STANDARDIA：低频访问存储。 默认为STANDARD。 E ENDPOINT 或 endpoint ENDPOINT 设置对象存储的Endpoint。 注意 Endpoint必须与所使用的对象存储服务一一对应：若使用OOS对象存储服务，需填写OOS的Endpoint；若使用兼容S3的其他对象存储服务，则需填写它的Endpoint。 如果仅输入域名将会使用HTTPS协议进行访问。 具体OOS Endpoint详见OOS Endpoint和区域。 signversion VERSION 指定上云签名认证的类型： v2：V2签名认证。 v4：V4签名认证。 默认值为v2。 region REGION 表示Endpoint资源池所在区域。具体region详见OOS Endpoint和区域。 V4签名时，此项必填。 M CLOUDCOMPRESSION 或 cloudcompression CLOUDCOMPRESSION 是否压缩数据上传至对象存储： Enabled（on）：压缩数据上传至对象存储。 Disabled（off）：不压缩数据上传至对象存储。 默认值为Enabled（on）。 O OBJECTSIZE 或 objectsize OBJECTSIZE 数据存储在对象存储中的大小。 取值：128、256、512、1024、2048、4096、8192，单位是KiB。默认值为1024。 X PREFIX 或 prefix PREFIX 设置对象存储中的前缀名称，设置前缀名称后，卷数据会存在存储桶以前缀命名的类文件夹中。如果未指定前缀，则直接存储在以卷名称命名的类文件夹中。 取值：字符串形式，长度范围是1~256。 qosname QOSNAME 指定QoS策略名称。 说明 创建卷时，如果指定QoS策略名称不存在，那么同时创建QoS策略，新创建的QoS策略的回收策略默认为Delete。 对于集群版，不指定QoS策略时： 如果卷的缓存存储池和存储池同时存在，卷的QoS策略为缓存存储池设置的“存储池内卷的默认QoS策略”；如果缓存存储池未设置“存储池内卷的默认QoS策略”，则卷无QoS策略。 如果卷只有存储池，卷的QoS策略为存储池设置的“存储池内卷的默认QoS策略”；如果存储池未设置“存储池内卷的默认QoS策略”，则卷无QoS策略。 取值：字符串形式，长度范围1~64，只能由字母、数字和短横线()组成，区分大小写，且仅支持以字母或数字开头。 注意 如果没有指定QOSNAME ，但是设置了IOPS/Bps中的任何一个参数，则根据IOPS/Bps自动创建一个QoS策略，系统为策略名赋值：lunlunnameqostimestamp。 如果指定了QOSNAME 以及IOPS/Bps中的任何一个参数，则QOSNAME不能与已存在的QoS策略重名。 如果指定了QOSNAME ，没有设置IOPS/Bps中的任何一个参数，则QOSNAME需要为已存在的QoS策略名称。 iops IOPS 每秒能够进行读写操作次数的最大值。 取值：整数形式，取值为[1, 999999999]，默认值为1。1表示不限制。 readiops READIOPS 每秒能够进行读操作次数的最大值。 取值：整数形式，取值为[1, 999999999]，默认值为1。1表示不限制。 writeiops WRITEIOPS 每秒能够进行写操作次数的最大值。 取值：整数形式，取值为[1, 999999999]，默认值为1。1表示不限制。 bps BPS 每秒可传输数据量的最大值。 取值：整数形式，数字后面可以输入单位简写B/b、K/k、M/m、G/g、T/t，分别代表B/s、KiB/s、MiB/s、GiB/s、TiB/s。默认单位是B/s，默认值为1，表示不限制。 如果单位是B/s，取值为[1, 4096000000000]。 如果单位是KiB/s，取值为[1, 4000000000]。 如果单位是MiB/s，取值为[1, 3906250]。 如果单位是GiB/s，取值为[1, 3814]。 如果单位是TiB/s，取值为[1, 3]。 readbps READBPS 读带宽上限。 取值：整数形式，数字后面可以输入单位简写B/b、K/k、M/m、G/g、T/t，分别代表B/s、KiB/s、MiB/s、GiB/s、TiB/s。默认单位是B/s，默认值为1，表示不限制。 如果单位是B/s，取值为[1, 4096000000000]。 如果单位是KiB/s，取值为[1, 4000000000]。 如果单位是MiB/s，取值为[1, 3906250]。 如果单位是GiB/s，取值为[1, 3814]。 如果单位是TiB/s，取值为[1, 3]。 writebps WRITEBPS 写带宽上限。 取值：整数形式，数字后面可以输入单位简写B/b、K/k、M/m、G/g、T/t，分别代表B/s、KiB/s、MiB/s、GiB/s、TiB/s。默认单位是B/s，默认值为1，表示不限制。 如果单位是B/s，取值为[1, 4096000000000]。 如果单位是KiB/s，取值为[1, 4000000000]。 如果单位是MiB/s，取值为[1, 3906250]。 如果单位是GiB/s，取值为[1, 3814]。 如果单位是TiB/s，取值为[1, 3]。 iopsburst IOPSBURST 使用Burst功能时，每秒能够进行读写操作次数的最大值。 取值：整数形式。只有当iops IOPS 大于等于1时，此项设置为1或(IOPS, 999999999]内的正整数方可生效。默认值为1，表示不限制。 readiopsburst READIOPSBURST 使用Burst功能时，每秒能够进行读操作次数的最大值。 取值：整数形式。只有当readiops READIOPS 大于等于1时，此项设置为1或(READIOPS, 999999999]内的正整数方可生效。默认值为1，表示不限制。 writeiopsburst WRITEIOPSBURST 使用Burst功能时，每秒能够进行写操作次数的最大值。 取值：整数形式。只有当writeiops WRITEIOPS 大于等于1时，此项设置为1或(WRITEIOPS 999999999]内的正整数方可生效。默认值为1，表示不限制。 bpsburst BPSBURST 使用Burst功能时，每秒可传输的数据量最大值。 取值：整数形式，数字后面可以输入单位简写B/b、K/k、M/m、G/g、T/t，分别代表B/s、KiB/s、MiB/s、GiB/s、TiB/s。默认单位是B/s，默认值为1，表示不限制。只有当bps BPS大于等于1时，在单位相同的情况下，此项设置为下列取值范围方可生效： 如果单位是B/s，取值为1或(BPS, 4096000000000]内的正整数。 如果单位是KiB/s，取值为1或(BPS, 4000000000]内的正整数。 如果单位是MiB/s，取值为1或(BPS, 3906250]内的正整数。 如果单位是GiB/s，取值为1或(BPS, 3814]内的正整数。 如果单位是TiB/s，取值为1或(BPS, 3]内的正整数。 readbpsburst READBPSBURST 使用Burst功能时，读带宽上限。 取值：整数形式，数字后面可以输入单位简写B/b、K/k、M/m、G/g、T/t，分别代表B/s、KiB/s、MiB/s、GiB/s、TiB/s。默认单位是B/s，默认值为1，表示不限制。只有当readbps READBPS大于等于1时，在单位相同的情况下，此项设置为下列取值范围方可生效： 如果单位是B/s，取值为1或(READBPS, 4096000000000]内的正整数。 如果单位是KiB/s，取值为1或(READBPS, 4000000000]内的正整数。 如果单位是MiB/s，取值为1或(READBPS, 3906250]内的正整数。 如果单位是GiB/s，取值为1或(READBPS, 3814]内的正整数。 如果单位是TiB/s，取值为1或(READBPS, 3]内的正整数。 writebpsburst WRITEBPSBURST 使用Burst功能时，写带宽上限。 取值：整数形式，数字后面可以输入单位简写B/b、K/k、M/m、G/g、T/t，分别代表B/s、KiB/s、MiB/s、GiB/s、TiB/s。默认单位是B/s，默认值为1，表示不限制。只有当writebps WRITEBPS大于等于1时，在单位相同的情况下，此项设置为下列取值范围方可生效： 如果单位是B/s，取值为1或(WRITEBPS, 4096000000000]内的正整数。 如果单位是KiB/s，取值为1或(WRITEBPS, 4000000000]内的正整数。 如果单位是MiB/s，取值为1或(WRITEBPS, 3906250]内的正整数。 如果单位是GiB/s，取值为1或(WRITEBPS, 3814]内的正整数。 如果单位是TiB/s，取值为1或(WRITEBPS, 3]内的正整数。 iopsburstsecs IOPSBURSTSECS 使用Burst功能时，按照Burst上限的能力进行读写操作所能持续的时间。 注意 只有在IOPS Burst功能启用时，此配置才生效。 取值：整数形式，取值为[1, 999999999]，默认值为1，单位是秒。 readiopsburstsecs READIOPSBURSTSECS 使用Burst功能时，按照Burst上限的能力进行读操作所能持续的时间。 注意 只有在Read IOPS Burst功能启用时，此配置才生效。 取值：整数形式，取值为[1, 999999999]，默认值为1，单位是秒。 writeiopsburstsecs WRITEIOPSBURSTSECS 使用Burst功能时，按照Burst上限的能力进行写操作所能持续的时间。 注意 只有在Write IOPS Burst功能启用时，此配置才生效。 取值：整数形式，取值为[1, 999999999]，默认值为1，单位是秒。 bpsburstsecs BPSBURSTSECS 使用Burst功能时，按照Burst上限的流量能力所能持续的时间。 注意 只有在BPS Burst功能启用时，此配置才生效。 取值：整数形式，取值为[1, 999999999]，默认值为1，单位是秒。 readbpsburstsecs READBPSBURSTSECS 使用Burst功能时，按照Burst上限的读流量能力所能持续的时间。 注意 只有在Read BPS Burst功能启用时，此配置才生效。 取值：整数形式，取值为[1, 999999999]，默认值为1，单位是秒。 writebpsburstsecs WRITEBPSBURSTSECS 使用Burst功能时，按照Burst上限的写流量能力所能持续的时间。 注意 只有在Write BPS Burst功能启用时，此配置才生效。 取值：整数形式，取值为[1, 999999999]，默认值为1，单位是秒。

本页介绍天翼云TeleDB数据库会话管理。 可在该功能中识别数据库中的长事务、未提交事务，并操作终止异常会话，恢复数据库的稳定性。 以长时间未提交事务为例，在会话管理中查询长时间（5s以上）不提交的事务。 发现未提交事务信息。 选中对应的未提交事务会话，并结束会话。 单击确定。 看到结束会话成功提示。

本页介绍天翼云TeleDB数据库死锁分析相关操作。 可诊断出数据库的最近一次历史死锁信息，看到死锁环和数据库回滚的事务信息。 以诊断近1天的死锁为例，单击立即诊断。 发现死锁信息，单击查看详情。 看到死锁日志记录。

本页介绍天翼云TeleDB数据库性能容量评估相关信息。 性能容量评估功能是指基于数据库实例的监控指标，通过指标的统计分析实例当前风险及未来可能发生的风险。 查看性能容量评估详情 可以查看实例下各个节点的CPU，内存，TPS，同步时延以及磁盘的状况，以及对应最大值，平均值以及分布情况。 单击性能容量评估进入界面。 查看评估详情，查看各项性能指标的统计情况。 查看指标历史情况以及未来趋势。 可以进一步查看某一节点对应指标的历史情况以及指标未来可能趋势情况。 在评估详情栏里选择需要查看的指标单击对应节点的饼图。 查看指标历史情况以及指标未来趋势。 查看实例当前的风险评估和操作建议。 评估实例的各项监控指标，检测指标时候存在异常，若存在异常情况，则会识别实例下任一节点的当前风险并给出对应的操作建议。 单击评估结果和建议的右侧任意一个表格图标按钮，注意：运行良好状态下表格按钮为禁用态。 查看实例当前的风险评估与操作建议，用户可以根据操作建议考虑采取对应操作。

本页介绍天翼云TeleDB数据库如何查看慢SQL诊断页面。 1. 单击诊断 ，进入慢SQL诊断页面。 2. 查看SQL诊断优化结果。 3. 单击实际执行 计划，查看慢SQL对应实际执行计划。 4. 单击执行 ，查看实际执行计划。 5. 单击确定 ，确认要查看实际执行计划。 6. 单击重新执行 ，会再次执行查询当前慢SQL实际执行计划的语句。 7. 下滑滚轮，查看执行计划可视化。 8. 单击索引建议 ，查看当前慢SQL的索引优化建议。 9. 查看索引优化建议。 10. 单击语句优化建议 ，查看语句优化建议。 11. 单击查看参考案例 。 12. 查看参考案例。 13. 单击确定 ，返回SQL诊断优化页面。 14. 返回SQL诊断优化页面。 15. 单击确定 ，返回慢查询分析页面。 16. 返回慢查询分析页面。

本页介绍天翼云TeleDB数据库如何查看慢日志。 1. 单击慢查询分析 进入界面。 2. 单击时间框查询对应时间段内的慢SQL 3. 查看慢日志展示。 4. 单击全部用户 ，选择用户对应的慢SQL。 5. 单击SQL语句 ，选择慢SQL的筛选条件，并在右侧方框输入具体的筛选条件。 6. 单击查询 ，筛选出符合条件的慢SQL。 7. 单击重置 ，清空之前的筛选条件

参数名称 参数说明 模板 Agent沙箱支持base、codeinterpreter和browserchromium三种类型沙箱模板 超时时间 沙箱存活时长，沙箱创建后超过该时长，会被自动销毁 能否访问公网 默认所有沙箱都能访问公网 能否开启安全访问沙箱 开启后，访问沙箱里面需要鉴权 环境变量 沙箱中会增加配置的环境变量

设置沙箱超时时间 每个沙箱都有一个 timeout（“超时时间”）配置，当沙箱的运行时间超过该配置值时，沙箱将自动关闭并释放。 您可以参考如下方式在启动的时候显式指定 timeout 的配置值，如果未指定，则默认值为 5 分钟。推荐按需设置 timeout 的值，以避免不必要的资源浪费。 python from dotenv import loaddotenv from e2bcodeinterpreter import Sandbox loaddotenv() sbx Sandbox.create(template"codeinterpreter", timeout60) 单位为秒。 代码执行 execution sbx.runcode("print('hello world')") print(execution.logs)

概述 本章节主要介绍沙箱模板管理相关功能。 沙箱模板管理 查看沙箱模板 Agent沙箱提供三种模板，即：基础模板base、代码解释器模板codeinterpreter和浏览器模板browserchromium。 操作步骤 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱模板，查看沙箱模板。

概述 本章节主要介绍使用代码解释器codeinterpreter模板创建的沙箱。代码解释器沙箱实例提供了一个安全且强大的代码代码执行沙箱环境，在该类型沙箱时里中可以执行以Python、JavaScript等5种语言代码、管理文件系统、执行shell命令等功能。 代码解释器类型沙箱在基础沙箱的基础上，增加了代码运行的能力，这里为了避免赘述，只展示代码运行的功能。 前置操作 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱实例，创建codeinterpreter类型沙箱实例。 3. 点击在线调试，进入codeinterpreter类型沙箱实例。 执行代码 操作步骤 1. 选择需要执行的代码文件，点击运行。 2. 查看代码运行结果。

功能说明 浏览器实例用于在 Agent 沙箱中提供可远程访问的浏览器运行环境。 您可以通过可视化方式查看浏览器运行画面，也可以通过自动化接口对页面进行程序化操作，适用于调试、测试、流程自动化等场景。 适用场景 网页自动化测试（打开页面、点击、输入、断言等）。 业务流程自动化（登录、检索、采集、表单提交等）。 在线问题排查（通过可视化调试观察实例状态并复现问题）。 前提条件 已开通并进入 Agent 沙箱服务。 已具备创建沙箱实例的权限。 使用限制 浏览器实例运行时长受沙箱生命周期与配额限制。 自动化调试地址包含访问令牌，请妥善保管，避免泄露。 涉及登录态、验证码或人机校验页面时，需结合业务逻辑处理。 请勿在实例内存放敏感长期数据，建议任务完成后及时释放实例。 操作步骤 步骤一：进入沙箱实例页面 1. 登录 Agent 沙箱控制台。 2. 在左侧导航中进入沙箱实例。 步骤二：创建浏览器实例 1. 点击创建实例。 2. 选择浏览器模板，可按需修改模板参数。 3. 点击确认。 4. 步骤三：进入 VNC 调试 1. 在沙箱实例列表中，选择目标实例的操作列点击VNC 调试。 2. 在打开的调试窗口中观察浏览器运行画面并进行交互。

概述 本章节主要介绍身份凭证管理相关功能。 身份凭证管理 查看身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 左侧菜单选择身份凭证，查看身份凭证。 创建身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，点击创建身份凭证，填写API Key名称，点击确定。 3. 查看API Key的值。 编辑身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，找到需要编辑的身份凭证，在操作列点击编辑，修改API Key名称，点击确定。 删除身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，找到需要删除的身份凭证，在操作列点击删除，确认无误后，点击确定。

概述 本章节主要介绍沙箱模板管理相关功能。 沙箱模板管理 查看沙箱模板 Agent沙箱提供三种模板，即：基础模板base、代码解释器模板codeinterpreter和浏览器模板browserchromium。 操作步骤 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱模板，查看沙箱模板。

参数名称 参数说明 模板 Agent沙箱支持base、codeinterpreter和browserchromium三种类型沙箱模板 超时时间 沙箱存活时长，沙箱创建后超过该时长，会被自动销毁 能否访问公网 默认所有沙箱都能访问公网 能否开启安全访问沙箱 开启后，访问沙箱里面需要鉴权 环境变量 沙箱中会增加配置的环境变量

概述 本章节主要介绍身份凭证管理相关功能。 身份凭证管理 查看身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 左侧菜单选择身份凭证，查看身份凭证。 创建身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，点击创建身份凭证，填写API Key名称，点击确定。 3. 查看API Key的值。 编辑身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，找到需要编辑的身份凭证，在操作列点击编辑，修改API Key名称，点击确定。 删除身份凭证 操作步骤 1. 登录Agent沙箱控制台。 2. 在身份凭证菜单下，找到需要删除的身份凭证，在操作列点击删除，确认无误后，点击确定。

概述 本章节主要介绍使用代码解释器codeinterpreter模板创建的沙箱。代码解释器沙箱实例提供了一个安全且强大的代码代码执行沙箱环境，在该类型沙箱时里中可以执行以Python、JavaScript等5种语言代码、管理文件系统、执行shell命令等功能。 代码解释器类型沙箱在基础沙箱的基础上，增加了代码运行的能力，这里为了避免赘述，只展示代码运行的功能。 前置操作 1. 登录Agent沙箱控制台。 2. 左侧菜单选择沙箱实例，创建codeinterpreter类型沙箱实例。 3. 点击在线调试，进入codeinterpreter类型沙箱实例。 执行代码 操作步骤 1. 选择需要执行的代码文件，点击运行。 2. 查看代码运行结果。

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 719340484461969408

参数 参数类型 说明 示例 下级对象 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b

接口功能介绍 本接口用于修改回调模板。 接口约束 1. 修改模板前确保存在该回调模板。 2. url会进行批量修改，未传参的url将被置空。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI PUT /v2/callbackTemplate/ 路径参数 参数 是否必填 参数类型 说明 示例 下级对象 TemplateId 是 String 模板ID。 739943519892963328 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 Description 否 String 模板描述，长度小于等于256个字符。 回调模板 CallbackKey 是 String 回调Key。 abc123 DeviceStatusNotifyUrl 否 String 设备状态回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < StreamStatusNotifyUrl 否 String 流状态回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < RecordNotifyUrl 否 String 录制回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 < AiEventNotifyUrl 否 String AI回调URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少选择一种。 <

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 SortBy 否 String 选择按一个字段排序，默认为CreatedTime，按照创建时间排序。取值：CreatedTime：创建时间；UpdatedTime：更新时间； CreatedTime SortDirection 否 String 排序方式，默认升序。取值：asc：升序；desc：降序。 asc PageNum 否 Integer 第几个分页，默认为1。 1 PageSize 否 Integer 分页大小，默认为20，取值范围为1～1000。 20

参数 参数类型 说明 示例 下级对象 Region String 设备接入区域。 0851002 InNetworkType String 接入网络类型，默认public。取值：public：互联网；private：专线网络。 public OutNetworkType String 播放网络类型，默认public。取值：public：互联网；private：专线网络。 public Device Object 设备信息。 Device VideoDevice Object 视频协议设备信息。 VideoDevice ViidDevice Object 视图协议设备信息。 ViidDevice CreatedTime String 设备创建时间。 1685515845343 UpdatedTime String 设备更新时间。 1685516000079 RequestId String 请求ID。 362d4e78556b47129182d0881fade86b 表 Device

参数 是否必填 参数类型 说明 示例 下级对象 RecordTemplateId 是 String 模板id 717074786139029504

参数 参数类型 说明 示例 下级对象 ChannelSize Integer 通道数量。 1 MaxChannelSize Integer 最大通道数量。 1 OnlineChannels Integer 在线通道数量。 1 OfflineChannels Integer 离线通道数量。 0 OnlineStreams Integer 在线流数量。 1 OfflineStreams Integer 离线流数量。 0 FailedStreams Integer 失败流数量。 0 表 Industry

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

枚举参数 无 请求示例 请求url GET '/v2/gb28181Certs?PageNum1&PageSize20' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "bed9f443d64e4361ad272860d4ab67ca","returnObj": {"PageNum": 1,"PageSize": 20,"TotalPage": 1,"TotalNum": 1,"gb28181Certs": [{"UserName": "test","UserType": "normal","Description": "","CreatedTime": "20220922093159","UpdatedTime": "20221021150614"}],"RequestId": "bed9f443d64e4361ad272860d4ab67ca"}} 状态码 请参考 状态码 错误码 请参考 错误码

枚举参数 无 请求示例 请求url PUT '/v2/devices/32388487739092996/records/stopCloudRecord' 请求头header 无 请求体body 无 响应示例 {"statusCode": 200,"message": "请求成功","requestId": "716580ae4fe14821b9cfdad0066c2649","returnObj": {"CreatedTime": "20230506 15:29:18","UpdatedTime": "20230506 16:02:34","RequestId": "716580ae4fe14821b9cfdad0066c2649"}} 状态码 请参考 状态码 错误码 请参考 错误码

接口功能介绍 本接口用于创建GB28181凭证，该凭证用于GB28181设备注册。 接口约束 创建的凭证名称请勿重复。 请求参数说明： String类型的参数，传""等同于不传。 Integer类型的参数，传0等同于不传。 Boolean类型的参数，传false等同于不传。 URI POST /v2/gb28181Certs 路径参数 无 Query参数 无 请求参数 请求头header参数 无 请求体body参数 参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名，长度164位，仅支持输入小写字母和数字。 cert Password 是 String 凭证密码，凭证密码长度为8位～32位的字符串，至少包含以下三种字符：大写字母、小写字母、数字和特殊字符（@ ）。 qwER1234 Description 否 String 凭证描述。 cert 响应参数 参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj 表 returnObj 参数 参数类型 说明 示例 下级对象 UserName String 凭证用户名。 cert UserType String 凭证类型。 normal Description String 凭证描述。 描述 CreatedTime String 凭证创建时间。 1681370054428110 UpdatedTime String 凭证更新时间。 1681370054428110 RequestId String 请求ID。 64c9f09a7d434519abbcdd5e20620732

参数 是否必填 参数类型 说明 示例 下级对象 DeviceId 是 String 设备ID。 752657499261403136

参数 参数类型 说明 示例 下级对象 statusCode Integer 响应状态码。 200 error String 错误码，执行成功时，不返回该字段。 VSS0001 message String 响应信息。 请求成功 requestId String 请求ID。 362d4e78556b47129182d0881fade86b returnObj Object 响应数据，执行失败时，不返回该字段。 returnObj

参数 是否必填 参数类型 说明 示例 下级对象 UserName 是 String 凭证用户名。 cert