华为云用户手册

请求消息示例 POST /v1/mmc/management/cycleconferences Connection: keep-alive X-Access-Token: cnr1510zTBhrfUsymQ0srhW2RYS99r9G5SQoTLWN Content-Type: application/json user-agent: WeLink -desktop Content-Length: 548 Host: api.meeting.huaweicloud.com User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191) { "subject": "例行周期会议", "mediaTypes": "Data,Voice,HDVideo", "startTime": "", "length": 120, "timeZoneID": "56", "vmrFlag": 1, "vmrID": "ff80808167ef1edf0167f339533f05a8", "cycleParams": { "startDate": "2021-08-31", "endDate": "2021-09-02", "cycle": "Day", "interval": 1, "preRemindDays": 1 }, "attendees": [ { "userUUID": "ff80808167ef1edf0167f339533d05a6", "name": "苏州分部", "email": "******", "sms": "+991116006724", "deptName": "企业协同云服务项目群", "role": 0, "phone": "+99119*****724", "type": "normal" } ], "confConfigInfo": { "isSendNotify": "false", "isSendSms": "false", "isSendCalendar": "false" }, "recordType": 0 }

响应参数 表4 响应参数 参数 类型 描述 [数组元素] Array of ConferenceInfo 会议信息列表。 表5 Subconfs 数据结构 名称 类型 描述 cycleSubConfID string 子会议UUID。 conferenceID string 会议ID。 mediaType string 会议的媒体类型。 Voice：语音 Video：标清视频 HDVideo：高清视频 Data：数据 startTime string 会议起始时间(格式:YYYY-MM-DD HH:MM)。 endTime string 会议结束时间(格式:YYYY-MM-DD HH:MM)。 isAutoRecord Integer 是否自动开启云录制。 0: 不自动启动 1: 自动启动 confConfigInfo Confconfinginfo object 周期子会议其他配置信息。 recordAuthType Integer 观看/下载录播的鉴权方式。 0: 可通过链接观看/下载 1: 企业用户可观看/下载 2: 与会者可观看/下载 description string 会议描述。长度限制为200个字符。 表6 Confconfiginfo 数据结构 名称 类型 描述 callInRestriction Integer 允许加入会议的范围。 0: 所有用户 2: 企业内用户 3: 被邀请用户 audienceCallInRestriction Integer 允许加入网络研讨会的观众范围。 0：所有用户 2：企业内用户和被邀请用户 allowGuestStartConf Boolean 是否允许来宾启动会议。 true: 允许来宾启动会议 false: 禁止来宾启动会议 说明： 仅随机会议ID有效。 enableWaitingRoom Boolean 是否启用等候室。 showAudienceCountInfo ShowAudienceCountInfo object 网络研讨会观众数显示策略。 表7 ShowAudienceCountInfo 数据结构 名称 类型 描述 showAudienceMode Integer 观众显示策略:服务端用来计算观众人数下发给客户端控制观众显示。 0: 不显示 1: 倍增显示与会人数。基于实时与会人数或累计与会人次（假设为N），可以再进行倍增设置。支持设置倍增倍数X和基础人数Y，设置后，显示的人数为：N*X+Y baseAudienceCount Integer 基础人数。范围是0~10000。 multiple Double 倍增倍数。范围是1~10, 支持设置到小数点后1位。

请求参数 表2 参数说明 参数 是否必须 类型 位置 描述 userUUID 否 String Query 用户的UUID。 说明： 该参数将废弃，请勿使用。 X-Access-Token 是 String Header 授权令牌。获取“执行App ID鉴权”响应的accessToken。 X-Authorization-Type 否 String Header 标识是否为第三方portal过来的请求。 说明： 该参数将废弃，请勿使用。 X-Site-Id 否 String Header 用于区分到哪个H CS O站点鉴权。 说明： 该参数将废弃，请勿使用。 startTime 否 String Body 会议开始时间（UTC时间）。格式：yyyy-MM-dd HH:mm。 说明： 创建预约会议时，如果没有指定开始时间或填空串，则表示会议马上开始 时间是UTC时间，即0时区的时间 length 否 Integer Body 会议持续时长，单位分钟。默认30分钟。 最大1440分钟（24小时），最小15分钟。 subject 否 String Body 会议主题。长度限制为128个字符。 mediaTypes 是 String Body 会议的媒体类型。 Voice：语音会议 HDVideo：视频会议 groupuri 否 String Body 软终端创建即时会议时在当前字段带临时群组ID，由服务器在邀请其他与会者时在或者conference-info头域中携带。 长度限制为31个字符。 attendees 否 Array of Attendee objects Body 与会者列表。 cycleParams 否 CycleParams object Body 周期会议的参数，当会议是周期会议的时候该参数必须填写。 isAutoRecord 否 Integer Body 会议是否自动启动录制，在录播类型为：录播、录播+直播时才生效。默认为不自动启动。 1：自动启动录制 0：不自动启动录制 encryptMode 否 Integer Body 会议媒体加密模式。默认值由企业级的配置填充。 0：自适应加密 1 : 强制加密 2 : 不加密 language 否 String Body 会议通知短信或邮件的语言。默认中文。 zh-CN：中文 en-US：英文 timeZoneID 否 String Body 会议通知中会议时间的时区信息。时区信息，参考时区映射关系。 说明： 举例：“timeZoneID”:"26"，则通过华为云会议发送的会议通知中的时间将会标记为如“2021/11/11 星期四 00:00 - 02:00 (GMT) 格林威治标准时间:都柏林, 爱丁堡, 里斯本, 伦敦”。 startDate和endDate中的日期是timeZoneID指定时区的日期。 recordType 否 Integer Body 录播类型。默认为禁用。 0: 禁用 1: 直播 2: 录播 3: 直播+录播 说明： 当录播类型含有直播属性（recordType为1或3），则liveAddress或者auxAddress至少填一个，否则会中无直播功能。 liveAddress 否 String Body 主流直播推流地址，在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。 auxAddress 否 String Body 辅流直播推流地址，在录播类型为 :直播、直播+录播时有效。最大不超过255个字符。 recordAuxStream 否 Integer Body 是否录制辅流，在录播类型为：录播、录播+直播时有效。默认只录制视频主流，不录制辅流。 0：不录制 1：录制 confConfigInfo 否 ConfConfigInfo object Body 会议其他配置信息。 recordAuthType 否 Integer Body 录播观看鉴权方式，在录播类型为:录播、直播+录播时有效。 0：可通过链接观看/下载 1：企业用户可观看/下载 2：与会者可观看/下载 vmrFlag 否 Integer Body 是否使用云会议室或者个人会议ID召开预约会议。默认0。 0：不使用云会议室或者个人会议ID 1：使用云会议室或者个人会议ID vmrID 否 String Body 绑定给当前创会账号的VMR ID。通过查询云会议室及个人会议ID接口获取。 说明： vmrID取上述查询接口中返回的id，不是vmrId 创建个人会议ID的会议时，使用vmrMode=0的VMR；创建云会议室的会议时，使用vmrMode=1的VMR vmrID使用个人会议ID占用并发资源，使用云会议室ID占用云会议室资源；vmrID既不使用个人会议ID也不使用云会议室ID（vmrflag=0，vmrID=null）占用并发资源 concurrentParticipants 否 Integer Body 会议方数，会议最大与会人数限制。 0：无限制 大于0：会议最大与会人数 supportSimultaneousInterpretation 否 Boolean Body 会议是否支持同声传译 true：支持 false：不支持 confResType 否 Integer Body 会议资源类型,此参数创建后不支持修改: 0: 并发 1: 云会议室 2: 网络研讨会 3: 预留模式,暂未开放

API开发 CodeArts API支持生成接口请求代码和业务代码，缩短前后端开发时长，规范代码结构。 基于接口定义，CodeArts API支持自动生成各种语言和框架的请求代码和业务代码。在API设计模块，接口文档界面右侧，即可看到“生成代码”的入口。 生成接口请求代码 单击“生成代码”下拉框，选择“生成接口请求代码”，弹出“生成接口请求代码”对话框。 支持生成多种语言的接口请求代码，单击右上角，可一键复制并直接粘贴，支持编辑修改和代码格式化。 生成业务代码 单击“生成代码”下拉框，选择“生成业务代码”，弹出“生成业务代码”对话框。 根据需要选择语言、生成范围（包括“仅当前接口及关联模型”和“整个项目”），单击“生成”将生成的代码存储到本地，开发者可以将代码复制到本地的研发工具（如IntelliJ IDEA）。

创建Markdown文件 新建Markdown，可通过以下三种方式完成。 方法一：单击目录树搜索框右侧的，在弹出的下拉框中，选择“新建Markdown”。 方法二：在目录树中选择一个目录，单击右侧图标，在弹出的下拉框中，选择“新建Markdown”。 进入“新建标签页”，在该标签页可以编辑Markdown文件，主要包括：目录、名称、正文。 目录：在上一步中，如果通过方法一和方法二新建Markdown，目录初始内容为空，可以手动选择；如果通过方法三新建Markdown，目录会自动生成为选中的目录，也可以手动修改。 名称：可根据业务需要自定义命名，不能为空。命名规则：只支持中文、英文、下划线、数字和“.”，且以中英文开头，长度为3-64个字符。 正文：可手动输入文字，也可使用组件插入特定的内容，如：表格、超链接、图片；正文样式也可以使用组件进行调整；正文编辑支持全屏模式；在左侧编辑正文时，右侧会同步展示编辑内容，便于查看、修改样式等。 编辑完成后，单击右上角“保存”，左侧目录树同步刷新，界面会自动跳转到文档页面，展示名称、正文，上方标签页的名称也会更新为Markdown文件名称。 移动Markdown（可选）。 单击并拖拽Markdown到目标目录后释放即可，移动成功后，目录树会自动刷新，Markdown文件的目录也会同步改变。

新建变量 在“环境参数”页面，单击，即可添加一个变量，根据需要填写变量信息： 参数项 说明 名称 当前环境变量参数名，可使用“$${参数名}”形式进行引用。 类型 包括：文本、随机字符串、随机整数、时间戳、格式化时间戳、生成UUID、Base64编码、MD5哈希值、密码或认证信息、SHA512编码。 值 当前环境变量的值，支持加密显示。 描述 根据不同类型，自动添加默认描述，也可根据设计需要自定义描述。 敏感变量 勾选为敏感变量后，云测对参数值加密存储，在测试结果日志中使用星号覆盖处理。敏感数据类型适用并不限于个人信息、鉴权信息等，如：姓名、地址、用户名等。 动态变量 动态参数的值可以在用例执行过程中被赋值。动态参数初始值可为空，被赋值之后，此处显示的是最新值。 动态参数赋值方法：在用例测试步骤“响应提取”的“赋值给环境动态参数”中设置后，测试执行时，响应提取的内容将被赋值给动态参数。

参数使用 环境参数可以用于整个项目，如：快捷调试的参数、URL，测试步骤的参数、检查点、变量、URL等都可以引用环境参数。 环境参数的引用形式为“$${参数名}”，如：参数名为“hostname”，则可以使用“$${hostname}”来引用该参数。可以按环境上下文配置环境参数，如：类生产环境中hostname=stage.example.com，生产环境中hostname=prod.example.com。测试执行时可选择环境执行。

邀请其他企业用户 企业A的账号中创建项目后，可以向该项目中添加企业B的账号中的 IAM 用户。 前提条件请参照邀请其他企业用户为项目成员。 单击“添加成员”旁的下拉框，选择“邀请其他企业用户”。 弹出“邀请其他企业用户”对话框，在“企业用户”下拉列表框中选择被邀请用户所属的账号，选择邀请方式并输入对应ID，单击“确定”。 用户ID：被邀请用户的ID，通过“我的凭证 ”获取“IAM用户ID”。获取方式请参考API凭证。 委托ID：被邀请账号中已创建的委托ID，通过IAM服务中的“委托”页面获取。 单击“确定”，可以将其他企业用户添加到项目中。

请求体 在Body页签中，可以查看请求体，目前支持的请求体有如下几类： none：无body参数。 form-data：Content-Type为“multipart/form-data”，可以输入请求体中每个参数的类型、名称和值。 application/x-www-form-urlencoded：Content-Type为“application/x-www-form-urlencoded”，可以输入请求体中每个参数的名称和值。 raw：在文本框中输入文本内容，在“raw”选项旁边可以下拉选择输入文本内容格式，如Text和Json。 请求参数的默认值均来自API设计的样例值。 在API调试页面修改请求参数，不能保存至API设计与API文档中。

接口路径 API调试页面的接口路径，可以选择http或https，并在定义的路径前自动添加了 域名 。添加的域名是在右上角选择的环境参数中定义的，单击左侧下拉箭头可在不同运行环境间切换，单击下拉箭头右上角按钮，可进行环境参数配置。 针对各个环境，默认提供变量“hostURL”参数作为添加到接口前的域名，从而拼接成完整地址。 可以看到对应环境“默认环境”中的“hostURL”参数的值“127.0.0.1:8080”被添加到接口URL前，作为整个路径的域名。鼠标悬浮在路径前，提示此前置URL来自于哪一环境，单击环境名称，可直接跳转至相应环境下进行编辑。 路径中大括号“{}”中的字符串表示Path参数。 路径中“?”后的字符串表示Query参数。 如果在调试页面路径栏下方的Query属性框中，对Query参数进行修改，路径中的Query参数也会同步变化。

创建项目 拥有创建项目权限的用户可以在CodeArts API的控制台创建新的项目。 登录CodeArts API控制台，单击“创建项目”，弹出“创建项目”窗口。 填写项目基本信息。 表1 新建项目参数说明 字段名称 是否必填 备注说明 项目名称 是 项目名称，限制128个字符。 项目描述 否 项目描述，限制1024个字符。 单击“确定”，完成项目创建。 CodeArts API还支持查看和使用在软件开发生产线CodeArts中创建的IPD项目。

设计API 接口文档应针对以下要素进行设计： 接口基本信息 接口路径 请求方式 接口请求参数 接口返回响应 安全方案 接口基本信息 填写接口的基本信息，包括： operationId ：同OpenAPI（Swagger）规范里的operationId。 用于标识此接口的唯一字符串，在相同根目录下必须是唯一的，只允许输入英文和数字。 摘要：接口的摘要信息。 状态：API生命周期的状态，包括设计中、联调中、测试中、测试完、已发布、将废弃、已废弃。 所属目录：接口在项目中所属的目录。 所属Tags：接口所属的Tags，可以直接选择所属目录信息当作所属Tags，也可以在所属Tags框中手动输入Tag名再回车来生成所属Tags。 描述：可添加接口的相关描述，包括接口功能、使用注意事项、使用场景定义等详细描述信息，接口描述支持通用Markdown语言编辑。 接口路径 接口的URL，客户端可以通过接口路径向服务端发起请求。以“/”开头，如：“/car”、“/car/{owner}”。 接口路径一般不包含域名和http、https协议名，如需加上域名进行调试，在调试功能页面有相应处理。 大括号“{}”中间的字符串表示Path参数。 不支持通过接口路径来添加Query参数，如：“/car?owner=zhangsan”。 支持创建100个项目中根目录。 请求方式 定义接口的请求方式，制定了客户端对服务端资源操作的方法，在API设计过程中，需要根据业务和操作类型选择合适的请求方式。 GET（获取）：用于获取指定资源，使用查询参数传递参数，适用于读取资源和查询数据。 POST（提交）：用于提交数据。POST请求可以传递请求体参数，适用创建新资源、提交表单数据或执行某些操作等场景。 PUT（更新）：用于更新或替换服务端的指定资源。 DELETE（删除）：用于删除服务端的指定资源。 OPTIONS（选项）：用于获取服务器支持的http方法和资源的相关信息。可用于客户端与服务端之间的握手过程，了解服务器所支持的方法和功能。 HEAD（请求头）：与GET类似，但只返回响应头部，不返回实体内容，用于获取资源的元信息，如：文件大小、修改日期等。 PATCH（补丁）：用于对资源进行局部更新。PATCH请求类似于PUT请求，但是只更新资源的一部分。 TRACE（跟踪）：用于建立与代理服务器的隧道连接，通常用于进行安全的SSL/TLS加密通信。 接口请求参数 Params、Path、Header、Cookies Query参数：接口请求中的一种参数传递方式，它通常用于传递一些可选的参数，比如过滤条件、排序方式、分页参数等。在URL中表现为末尾“?”后的字符串（如：“/car?owner=zhangsan”，那么“owner=zhangsan”即Query参数，其中“owner”为参数的key，“zhangsan”为参数的value）。 Path参数：也称为“路径参数”，是API请求中的一种参数传递方式。在URL中表现为大括号“{}”括起来的字符串（如：“/car/{owner}”，那么“{owner}”表示key为“owner”的Path参数）。 Header参数：请求头中的参数。 Cookies：类型为“小型文本文件”，是某些网站为了辨别用户身份，进行Session跟踪而储存在用户本地终端上的数据（通常经过加密），由用户客户端计算机暂时或永久保存的信息。 前置脚本：CodeArts API支持接口前置脚本操作，详见脚本能力。 后置脚本：CodeArts API支持接口后置脚本操作，详见脚本能力。 请求体 在发起http请求时，需要带上一些参数以便服务器处理，通过http请求体传递的参数被称为Body参数。Body参数包含在请求的主体部分中，通常是一些表单数据、JSON数据或者二进制数据。在发送请求时，会根据Body参数类型，自动在请求Header中添加对应Content-Type参数。若手工设置Content-Type的类型，则必须与Body的参数类型匹配，否则系统会自动忽略掉手动设置的Content-Type值。 none：无body参数。 application/json：json格式数据。Content-Type为 “application/json”。 application/xml：xml类型数据，用于标识文件和图像等媒体类型，也可以标识结构化数据。Content-Type为 “application/xml”。 multipart/form-data：表单数据。Content-Type为 “multipart/form-data”。 application/x-www-form-urlencoded：将表单数据编码后传输到服务器。数据被编码为一系列键值对，每个键值对之间以&连接，并且键与值之间以=分隔。Content-Type为“application/x-www-form-urlencoded” 。 此外，还支持将Body体数据结构提取为数据模型，根据Body体数据结构自动生成示例、以及单击“智能导入”，根据输入的Json自动生成数据结构功能。 接口返回响应 返回响应的定义包含：返回响应的状态码、响应内容的数据结构、响应示例和响应头。 返回响应的状态码：通过加号来添加运行接口后可能的响应状态码，单击响应状态码可以对状态码进行修改。 响应内容的数据结构：规定响应内容的格式，分为“application/json”、“application/xml”、“text/plain”三种，“application/json”和“application/xml”两种情况下可以对响应内容的结构进行进一步定义，如：响应内容为“application/json”，规定json内容里的参数类型等。另外还支持将响应体数据结构提取为数据模型。 响应示例：响应内容的示例。 响应头：返回响应的Header。 返回响应也可以直接引用公共模型中已定义好的“公共响应”，并且支持自动生成响应示例。 安全方案 OpenAPI规范中，安全模型对应OpenAPI3.0的components.securitySchemes。大部分的Web服务都需要经过身份认证才能访问，security就是用于描述API的安全信息和访问授权协议等信息的对象，Open API支持的最常见授权方案如下： API key HTTP Oauth2.0 OpenID Connect 安全方案引入需要在公共模型中建立安全模型，详见•安全模型。

手动导入 通过主页面的“更多功能”选项或单击左上角搜索框旁边的，可以展示当前支持的导入选项，可根据需要选择。 导入文件 选择响应格式的文件并上传，然后选择文件中系统识别出来的接口和数据模型导入。 Postman支持Collections和Environment数据集ZIP包的全量导入，也支持单个Collection文件导入。 Postman支持接口和接口用例的前置脚本及后置脚本导入。 导入URL 选择“导入Swagger URL”，输入URL，即可完成文档导入。 通过Swagger URL导入时，需要填写json数据文件的URL，而非Swagger UI的URL。

云日志 服务地址说明 云日志服务首页，基础URL为： https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer_rightsidebar#/cts/manager/groups 表3 参数说明表 参数名称 必填 类型 描述 regionId 是 String 区域ID，登录console页面后在浏览器的地址栏中获取。 日志搜索界面，基础URL为： https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer_rightsidebar#/cts/logEventsLeftMenu/events?groupId={groupId}&topicId={topicId}&epsId={epsId}&hideHeader={hideHeader}&fastAnalysisCollapsed={fastAnalysisCollapsed}&hideDashboard={hideDashboard}&hideFeedback={hideFeedback}&isFoldLabel={isFoldLabel}&hideStreamName={hideStreamName}&showK8sFilter={showK8sFilter}&clusterId={clusterId}&hideBarChart={hideBarChart}&hideTabs={hideTabs}&condition={condition} 表4 参数说明表 参数名称 必填 类型 默认值 描述 regionId 是 String 无 区域ID，登录console页面后在浏览器的地址栏中获取。 groupId 是 String 无 日志组ID。 topicId 是 String 无 日志流ID。 epsId 否 String 无 日志流所属的企业项目ID，若无企业项目，值为0。 hideHeader 否 Boolean false 是否隐藏左侧列表及顶部横向日志流列表，如需隐藏，该参数值为true。 使用iframe内嵌场景才会生效，不使用iframe内嵌场景则不生效。 fastAnalysisCollapsed 否 Boolean false 是否收起快速分析，如需默认收起，该参数值为true。 hideDashboard 否 Boolean false 是否隐藏创建仪表盘图标，如需隐藏，该参数值为true。 hideFeedback 否 Boolean false 是否隐藏评价按钮，如需隐藏，该参数值为true。 isFoldLabel 否 Boolean true 控制日志表格中的label字段是否换行，如需换行展示，该参数值为true。 hideStreamName 否 Boolean false 是否隐藏日志流名称，如需隐藏，该参数值为true。 showK8sFilter 否 Boolean false 是否展示容器日志筛选，容器日志搜索场景下，可选择该参数为true，控制是否展示容器日志筛选条件。 clusterId 否 String 无 集群ID，showK8sFilter参数为true时，该参数必填。 hideBarChart 否 Boolean false 是否默认收起日志条数统计图，如需默认收起，该参数值为true。 hideTabs 否 Boolean false 是否隐藏“日志搜索、 日志分析 、实时日志”标签tabs，默认不隐藏。如需隐藏，该参数值为true。 hideShare 否 Boolean false 是否隐藏“分享”按钮，默认不隐藏。如需隐藏，该参数值为true。（当前仅华北-北京四局点支持该参数） keepOnline 否 Boolean false 是否保持登录状态。如需一直保持登录状态，不退出登录，该参数值为true。 hideDocAndAccessLog 否 Boolean false 是否隐藏日志表格无数据时的“前往查看日志接入”和“更多搜索语法”链接。如需隐藏，该参数值为true。 condition 否 String 无 日志查询条件，如name:a and age:12 and addr:xx。 非必填 单个关键词形式为key:value 多个关键词用 and 隔开 关键词中不能包含英文分号（;）、英文冒号（:） 关键词中含有其他特殊字符如（+、=、？、#、%、&）需转换为十六进 图6 参数与界面对应关系图（仅供参考） 可视化日志搜索界面，基础URL为： https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer_rightsidebar#/cts/logEventsLeftMenu/events?visualization=true&groupId={groupId}&topicId={topicId}&epsId={epsId}&sql={sql} 表5 参数说明表 参数名称 必填 类型 默认值 描述 regionId 是 String 无 区域ID，登录console页面后在浏览器的地址栏中获取。 groupId 是 String 无 日志组ID。 topicId 是 String 无 日志流ID。 epsId 否 String 无 日志流所属的企业项目ID，若无企业项目，值为0。 hideHeader 否 Boolean false 是否隐藏左侧列表及顶部横向日志流列表，如需隐藏，该参数值为true。 sql 否 String 无 SQL查询语句，如SELECT count (*)。 图7 参数与界面对应关系图（仅供参考） 仪表盘界面，基础URL为： https://console.huaweicloud.com/lts/?region={regionId}&cfModuleHide=header_sidebar_floatlayer_rightsidebar#/cts/manager/dashboard?dashboardId={dashboardId}&hideDashboardList={hideDashboardList}&showCurrentdashboardGroup={showCurrentdashboardGroup}&streamId={streamId}&streamDisabled={streamDisabled}&readonly={readonly}&filter=key1:value1,value2;key2:value3,value4&autoFresh={autoFresh} 表6 参数说明表 参数名称 必填 类型 默认值 描述 示例 regionId 是 String 无 区域ID，登录console页面后在浏览器的地址栏中获取。 region=xx-xx-xx dashboardId 否 String 无 需要展示的仪表盘ID，默认值为""。 使用场景：当用户需要默认展示某仪表盘时，可添加此参数。 dashboardId=xxxxxxxx hideDashboardList 否 Boolean false 是否隐藏仪表盘选择下拉列表：默认不隐藏，true表示隐藏。 使用场景：当用户需要隐藏仪表盘下拉列表时，可通过添加该参数且值为true来实现。 hideDashboardList=true showCurrentdashboardGroup 否 Boolean false 是否只展示当前仪表盘所在分组/模板：默认值为false。 使用场景：当用户只需要展示当前仪表盘分组/模板的仪表盘时，可通过添加该参数且值为true来实现。 注意：若hideDashboardList参数值为true时，当前参数无效。 showCurrentdashboardGroup=true streamId 否 String 无 日志流ID：默认值为""。 使用场景：只适用于仪表盘模板。当用户需要默认选中某日志流时，可添加该参数。 streamId=xxxxxx streamDisabled 否 Boolean false 日志流下拉框：默认可选择，true标识不可选择 使用场景：只适用于仪表盘模板。当用户需要置灰日志流下拉框时，可添加该参数。 streamDisabled=true filter 否 String 无 过滤器参数，值为要选中的过滤器的名称及选中项。 key1、key2为过滤器名称，value1、value2为过滤器key1需要选中的值，value3、value4为过滤器key2需要选中的值。多个过滤器按照;分隔，多个选中项按照,分隔。 使用场景：当用户内嵌仪表盘界面需要默认选中某些过滤器的key、value时，可添加该参数。 filter=key1:value1,value2;key2:value3,value4 readonly 否 Boolean false 是否是只读场景，只读场景下，操作类按钮会被隐藏。例如：新建过滤器、添加/修改/删除仪表盘等。 使用场景：当用户只需要展示仪表盘，不需要操作权限时，可添加该参数。 readonly=true autoFresh 否 String 无 定时刷新时长，默认值为""。 使用场景：当用户需要指定默认定时刷新时长时，可添加此参数，当前支持的定时刷新时长参数取值为：0m，1m，5m，15m之一，对应：不定时刷新、1分钟定时刷新、5分钟定时刷新、15分钟定时刷新。 autoFresh=1m 图8 参数与界面对应关系图（仅供参考）

方案概述 云上用户经常会遇到多云或者跨Region采集日志的场景，典型场景有两种，分别是： 场景一：将互联网数据中心（Internet Data Center，以下简称IDC）或者第三方云厂商的日志采集到华为云LTS。 图1 第三方云厂商日志采集 场景二：将华为云RegionA的日志采集到华为云RegionB的LTS。 图2 跨Region日志采集 对于场景一和场景二，您需要先打通网络，再安装ICAgent，最后按照日志接入向导即可以将日志采集到LTS。 ICAgent：ICAgent是华为云日志服务的日志采集器，通过在主机上安装ICAgent，您可以将日志采集到LTS。安装ICAgent前，请确保本地浏览器的时间、时区与主机的时间、时区一致。 网络互通： 场景一：自建IDC或者第三方云厂商与华为云之间网络互通的典型方式是云专线DC，如果没有专线，您可以尝试VPN/公网IP方式。 场景二：华为云不同Region之间网络互通典型的方式是云连接CC/云专线DC，您也可以使用VPN/公网IP方式。 跳板机 安装在自建IDC/第三方云厂商/跨华为云Region的ICAgent无法直接访问华为云管理面上报日志的网段，需要配置跳板机进行数据转发；当您在进行POC测试，或者日志流量并不大的情况下，可以使用跳板机的方案。对于大流量的日志场景，如果您希望在生产环境中去掉跳板机，请提交工单给华为云网络技术支持工程师帮您设计网络直通的方案。 典型的跳板机配置是2vCPUs | 4GB，每台跳板机可以支持约30MB/s的流量转发，您可以根据自身的日志流量配置合理数量的跳板机，多台跳板机配置ELB进行流量分发。 本文将详细介绍将阿里云主机日志采集到华为云LTS的操作步骤，互联网数据中心和华为云上跨Region采集日志的操作方式与采集阿里云主机日志的方式类似。 以下将阿里云-华北二-北京局点的日志采集到华为云华东-上海一局点的LTS服务，云主机的操作系统为Linux环境。

方案概述 ELK是Elasticsearch、Logstash和Kibana的简称，它们组合起来提供了业界最常用的日志分析和可视化工具。 Elasticsearch是一个基于Lucene的开源、分布式、RESTful搜索和分析引擎。 Logstash是一个开源的、服务器端的数据处理管道，能够同时从多个来源实时接收、转换并将数据发送到用户选择的“存储库”。通常用于日志的收集、过滤和转发。 Kibana是一个开源的分析和可视化平台，用于数据的可视化、仪表盘创建和搜索查询。通常与Elasticsearch一起使用。 华为 云日志服务LTS 在功能丰富度、成本、性能方面优于开源ELK方案，具体对比可以参考云日志服务LTS对比自建ELK Stack有什么优势？。本文提供最佳实践，使用自定义Python脚本和LTS采集器ICAgent，协助用户将日志从Elasticsearch（简称ES）迁移到LTS中。 当前华为云支持ECS机器通过安装ICAgent来采集日志文件，因此可以基于该功能实现Elasticsearch日志导入云日志服务。 Elasticsearch数据先通过python脚本将数据落盘到ECS，然后通过LTS服务的日志接入功能，将落盘的日志文件采集到LTS服务。 图1 方案介绍流程图

背景信息 Syslog是网络上各种设备将日志收集到日志服务器的一种数据协议，它几乎被所有的网络设备支持，并且能够记录多种事件类型的日志消息，支持syslog的设备常见的有路由器、交换机、打印机等，甚至unix-like的服务器也可以支持产生syslog消息，用以记录用户的登录、防火墙事件、apache或者nginx access日志等。 Syslog主要是基于RFC5424和RFC3164定义相关格式规范，RFC3164协议是2001年发布的，RFC5424协议是2009年发布的升级版本。因为新版兼容旧版，且新版本解决了很多问题，因此推荐使用RFC5424协议。 本文介绍通过Syslog协议将日志上传到日志服务的操作步骤。您需要购买ECS作为Syslog汇聚服务器，Linux服务器默认自带Rsyslog，目前华为云主机默认未配置接收远程Syslog写入，需要手动开启。

方案概述 图1 方案流程图 您可以购买Linux云主机，配置为Syslog汇聚服务器，用于接收其他设备发送的日志数据；Syslog服务器默认接收日志大小为1024字节，超过会截断。 单台Syslog服务器处理日志能力为10MB/s，如果您的日志量较大，或者希望可靠性更高，可以购买多台ECS配置为Syslog服务器，并配置 ELB负载均衡 分发流量。 您需要在Syslog服务器上安装ICAgent，并配置日志采集规则，就可以将日志采集到LTS。

方案概述 云上用户经常会遇到多云或者跨Region采集Kubernetes日志场景，典型场景有两种，分别是： 场景一：将互联网数据中心（Internet Data Center，以下简称IDC）或者第三方云厂商的日志采集到华为云LTS。 图1 第三方云厂商日志采集 场景二：将华为云RegionA的日志采集到华为云RegionB的LTS。 图2 跨Region日志采集 对于场景一和场景二，您需要先打通网络，再安装ICAgent，最后按照日志接入向导即可以将日志采集到LTS。 ICAgent：ICAgent是华为云日志服务的日志采集器，通过在主机上安装ICAgent，您可以将日志采集到LTS。安装ICAgent前，请确保本地浏览器的时间、时区与主机的时间、时区一致。 网络互通： 场景一：自建IDC或者第三方云厂商与华为云之间网络互通的典型方式是云专线DC，如果没有专线，您可以尝试VPN/公网IP方式。 场景二：华为云不同Region之间网络互通典型的方式是云连接CC/云专线DC，您也可以使用VPN/公网IP方式。 跳板机 安装在自建IDC/第三方云厂商/跨华为云Region的ICAgent无法直接访问华为云管理面上报日志的网段，需要配置跳板机进行数据转发；当您在进行POC测试，或者日志流量并不大的情况下，可以使用跳板机的方案。对于大流量的日志场景，如果您希望在生产环境中去掉跳板机，请提交工单给华为云网络技术支持工程师帮您设计网络直通的方案。 典型的跳板机配置是2vCPUs | 4GB，每台跳板机可以支持约30MB/s的流量转发，您可以根据自身的日志流量配置合理数量的跳板机，多台跳板机配置ELB进行流量分发。 本文将详细介绍将第三方云厂商Kubernetes集群日志采集到华为云LTS的操作步骤，互联网数据中心和华为云上跨region采集日志的操作方式与采集第三方云厂商Kubernetes集群日志的方式类似。

SDK概述 华为云提供了直播服务端SDK，您可以直接集成服务端SDK来调用直播的相关API，从而实现对直播服务的快速操作。目前 视频直播 提供了Java、Python、Go和PHP四种语言SDK供开发者使用，如表1所示。 SDK已知安全漏洞及修复版本、规避方案，请单击表1中的SDK对应语言的Github地址进行查看。 如果无法正常打开GitHub仓库，请检查您所使用的网络是否可以正常访问公网。由于GitHub的服务器部署在国外，国内用户访问时容易遇到无法打开的情况，请切换网络后再尝试打开。 表1 服务端SDK 语言 Github地址 参考文档 JAVA huaweicloud-sdk-java-v3 Java SDK使用指导 Python huaweicloud-sdk-python-v3 Python SDK使用指导 Go huaweicloud-sdk-go-v3 Go SDK使用指导 PHP huaweicloud-sdk-php-v3 PHP SDK使用指导 支持的直播API如表2所示，后续SDK将会持续升级，支持所有直播API。 表2 SDK与API对应关系 Java SDK Python SDK Go SDK API参考 createDomain create_domain CreateDomain 创建直播域名 deleteDomain delete_domain DeleteDomain 删除直播域名 updateDomain update_domain UpdateDomain 修改直播域名 showDomain show_domain ShowDomain 查询直播域名 createDomainMapping create_domain_mapping CreateDomainMapping 域名映射 deleteDomainMapping delete_domain_mapping DeleteDomainMapping 删除直播域名映射关系 createTranscodingsTemplate create_transcodings_template CreateTranscodingsTemplate 创建直播转码模板 updateTranscodingsTemplate update_transcodings_template UpdateTranscodingsTemplate 修改直播转码模板 deleteTranscodingsTemplate delete_transcodings_template DeleteTranscodingsTemplate 删除直播转码模板 showTranscodingsTemplate show_transcodings_template ShowTranscodingsTemplate 查询直播转码模板 createStreamForbidden create_stream_forbidden CreateStreamForbidden 禁止直播推流 updateStreamForbidden update_stream_forbidden UpdateStreamForbidden 修改禁推属性 deleteStreamForbidden delete_stream_forbidden DeleteStreamForbidden 禁推恢复 listStreamForbidden list_stream_forbidden ListStreamForbidden 查询禁止直播推流列表 showBandwidth show_bandwidth ShowBandwidth 查询直播加速的带宽数据 listLiveSampleLogs list_live_sample_logs ListLiveSampleLogs 获取直播播放日志 createRecordRule create_record_rule CreateRecordRule 创建录制规则 listRecordRules list_record_rules ListRecordRules 查询录制规则列表 updateRecordRule update_record_rule UpdateRecordRule 修改录制规则 deleteRecordRule delete_record_rule DeleteRecordRule 删除录制规则 showRecordRule show_record_rule ShowRecordRule 查询录制规则配置 runRecord run_record RunRecord 提交录制控制命令 createRecordCallbackConfig create_record_callback_config CreateRecordCallbackConfig 创建录制回调配置 listRecordCallbackConfigs list_record_callback_configs ListRecordCallbackConfigs 查询录制回调配置列表 updateRecordCallbackConfig update_record_callback_config UpdateRecordCallbackConfig 修改录制回调配置 showRecordCallbackConfig show_record_callback_config ShowRecordCallbackConfig 查询录制回调配置 deleteRecordCallbackConfig delete_record_callback_config DeleteRecordCallbackConfig 删除录制回调配置 showTraffic show_traffic ShowTraffic 查询直播加速的流量数据 showOnlineUsers show_online_users ShowOnlineUsers 查询直播播放在线人数 listBandwidthDetail list_bandwidth_detail ListBandwidthDetail 查询播放带宽趋势接口 listDomainTrafficDetail list_domain_traffic_detail ListDomainTrafficDetail 查询播放流量趋势接口 listDomainBandwidthPeak list_domain_bandwidth_peak ListDomainBandwidthPeak 查询播放带宽峰值接口 listDomainTrafficSummary list_domain_traffic_summary ListDomainTrafficSummary 查询播放流量汇总接口 listUsersOfStream list_users_of_stream ListUsersOfStream 查询观众趋势接口 listQueryHttpCode list_query_http_code ListQueryHttpCode 查询直播拉流HTTP状态码接口 listTranscodeData list_transcode_data ListTranscodeData 查询转码用量接口 listRecordData list_record_data ListRecordData 查询录制用量接口 listSnapshotData list_snapshot_data ListSnapshotData 查询截图用量接口 showUpBandwidth show_up_bandwidth ShowUpBandwidth 查询上行带宽数据接口 showStreamCount show_stream_count ShowStreamCount 查询域名维度推流路数接口 listHistoryStreams list_history_streams ListHistoryStreams 查询历史推流列表接口 showStreamPortrait show_stream_portrait ShowStreamPortrait 查询播放画像信息接口 listSingleStreamFramerate list_single_stream_framerate ListSingleStreamFramerate 查询推流帧率数据接口 listSingleStreamBitrate list_single_stream_bitrate ListSingleStreamBitrate 查询推流码率数据接口 listLiveStreamsOnline list_live_streams_online ListLiveStreamsOnline 查询直播中的流信息

发布历史 记录了客户端版本发布历史，包括新特性、问题修复及优化等内容，用户可以在该页面下载最新版本客户端。 版本号 操作系统 OS支持 更新内容 发布时间 2.2.6 Windows 86 新特性： API设计、公共响应体和公共请求体中的数据结构支持提取数据模型；API设计接口树支持根目录搜索； 优化： API设计中将接口名称修改为了operationId，并增加了相关提示；将summary字段修改为必填； 修复： 交互优化并修复其他已知问题。 2025-05-28 2.2.0 Windows X86 新特性： 支持上海一region；API设计模块支持导出html格式接口文档； 项目设置模块导入数据列表支持搜索和排序； 修复： 修复其他已知问题。 2025-01-06 2.1.3 Windows X86 新特性： 项目管理模块支持接口推送至第三方； 2024-12-11 2.1.2 Windows X86 优化： API设计模块表单设计创建接口时title默认为根目录名称； API设计&快捷调试模块接口和模型的目录命名支持数字开头。 2024-12-04 2.1.1 Windows X86 修复： 修复部分已知问题。 2024-10-21 2.1.0 Windows X86 新特性： 项目支持分组功能、支持显示IPD类型的项目；新增系统公告能力，包含“测试计划”套餐试用提示；API设计模块增加项目概览；项目成员支持通过委托方式导入新成员； 2024-09-13 2.0.8 Windows X86 新特性： 项目管理模块新增定时导入swaggerURL能力；项目管理模块优化权限管理能力，与CodeArts权限同步； 快捷调试模块增加实际请求以及页面内名称修改能力。 2024-07-30 2.0.6 Windows X86 新特性： 项目管理支持YApi文件导入；快捷调试模块中，表单支持复制和另存为的便捷操作，URL支持引入环境变量；API设计模块中，接口导出功能支持Swagger2.0和JSON格式。 2024-06-04 2.0.5 Windows X86 新特性： API测试模块对接版本管理功能，支持版本切换； 版本管理新增测试用例数据，新增版本间导入测试用例功能； 导入功能优化：项目导入支持apifox文件前后置脚本导入；快捷调试支持Postman的Collection级别全量导入；API设计支持postman文件前后置脚本导入； 前后置脚本功能优化：支持创建或修改动态变量。 2024-05-10 2.0.4 Windows X86 新特性： 客户端新增未登录使用快捷调试能力；API设计模块新增设计审核能力、优化Swagger文件导入和Postman全量导入；API发布模块新增注册APIG网关能力。 2024-04-11 2.0.3 Windows X86 新特性： 项目管理模块新增导入Apifox项目能力；API测试模块新增关键字库功能，测试用例编排新增以下测试步骤模板：循环、if判断、URL请求、postman导入、分组。 2024-03-21 2.0.2 Windows X86 新特性： API设计模块中，新增前后置脚本功能；项目设置中，增加Mock功能设置页面。 2024-01-31 2.0.1 Windows X86 新特性： 增加扫码登录记住账号密码功能，新增快捷键能力，Postman文件可导入快捷调试，公共模型与快捷调试目录支持文件拖拽等功能。 2024-01-09 2.0.0 Windows X86 新特性： 增加公共组件编辑功能，不可视字符进行高亮提示，API测试增加默认变量MockURL。 2023-11-30 1.0.0 Windows X86 新特性： 客户端1.0.0版本正式发布，提供API表单化设计、文档管理、Mock&本地调试、快捷调试、规范校验、自动化测试及项目团队管理能力。 2023-05-22

步骤四：查看实时日志 完成日志接入配置后，可以在云日志服务控制台实时查看上报的日志。 如果您正在使用实时查看功能，请停留在实时查看页面，请勿切换页面。如果您离开实时查看页面，实时查看功能将会被关闭。 在“接入管理”页面，单击目标日志接入任务“所属日志流”列的日志流名称，即可进入日志流详情页。 单击“实时日志”页签，查看实时日志。 日志大约每隔5秒钟上报一次，在日志消息区域，您最多需要等待5秒钟左右，即可查看实时上报的日志。 图11 实时日志

步骤二：创建日志组和日志流 日志组和日志流是云日志服务进行日志管理的基本单位，在使用云日志服务时，您首先需要创建一个日志组，然后在日志组中创建日志流。 登录云日志服务控制台。 在“日志管理”页面，单击“创建日志组”，参考表3填写日志组相关信息。 图7 创建日志组 表3 参数说明 参数 说明 示例 日志组名称 日志组名称只支持输入英文、数字、中文、中划线、下划线及小数点，且不能以小数点、下划线开头或以小数点结尾。长度为1-64个字符。 日志采集后，将发送到对应的日志组中的日志流，如果日志较多，需要分门别类，建议您给日志组做好命名，方便后续快速查找日志。 lts-group-ECS 企业项目 选择业务需要的企业项目，默认为default。 default 日志存储时间(天) 日志组的存储时间，即日志上报到LTS后日志存储的时间。 日志数据默认存储30天，可以在1~365天之间设置。 云日志服务LTS根据配置的日志存储时间定时清理日志内容，例如日志存储时间为30天，上报到LTS的日志只保存30天，30天后开始删除日志内容。 30 标签 按照业务需求对不同的日志组添加对应的标签。本示例可不设置。 - 备注 自定义填写备注信息，字符长度0-1024个字符。本示例可不填写。 - 单击“确定”，日志组创建成功，即可在日志组列表下方生成一条日志组信息。 单击目标日志组名称对应的。 单击“创建日志流”，在“创建日志流”页面中，参考表4填写日志流相关信息。 图8 创建日志流 表4 参数说明 参数 说明 示例 日志组名称 默认显示目标日志组名称。 - 日志流名称 日志流名称只支持输入英文、数字、中文、中划线、下划线及小数点，且不能以小数点、下划线开头或以小数点结尾。长度为1-64个字符。 日志采集后，以日志流为单位，将多条日志数据发往云日志服务。如果日志较多，需要分门别类，建议您创建多个日志流，并给日志流做好命名，方便后续快速查找日志。 lts-topic-ECS 企业项目 选择业务需要的企业项目，默认为default。 default 日志存储 开启日志存储：日志将会被存入搜索引擎，能使用日志全量功能。 需要开启日志存储，才能开启日志存储时间。 开启 日志存储时间(天) 日志流的存储时间，即日志上报到LTS后日志存储的时间。 日志数据默认存储30天，可以在1~365天之间设置。 打开日志流的“日志存储时间”开关：日志的存储时间使用日志流设置的日志存储时间。 云日志服务LTS根据配置的日志存储时间定时清理日志内容，例如日志存储时间为30天，上报到LTS的日志只保存30天，30天后开始删除日志内容。 30 标签 按照业务需求对不同的日志组添加对应的标签。本示例可不添加。 - 匿名写入 匿名写入默认关闭，本示例默认关闭。 匿名写入适用于安卓/IOS/小程序/浏览器端上报日志。 关闭 备注 自定义填写备注信息，字符长度0-1024个字符。本示例可不填写。 - 单击“确定”。 日志流创建成功，即可在目标日志组下方生成一条日志流信息。

前提条件 注册账号并实名认证。使用LTS前，需要先注册一个华为账号并进行实名认证。如果您已有一个华为账号，可直接跳过如下操作。 进入华为云官网，单击页面右上角的“注册”。 参考 注册华为账号 并开通华为云中操作，完成注册。 注册后参考实名认证完成个人或企业账号实名认证。 为账户充值。如果您的账户有足够金额，请跳到下一个任务。如果您的账户还没有足够金额，请先为账户充值。 关于云日志服务LTS的价格，请参见LTS价格详情。 关于充值，请参见账户充值。 为用户添加云日志服务LTS的操作权限。 您需要有LTS的管理员权限“LTS FullAccess”，具体操作请参考授权IAM用户使用LTS。 本操作以Linux系统的ECS为例，准备好需要采集日志的ECS主机，详细请参考自定义购买ECS。如果您已有可用的ECS主机，可重复使用，不需要再次创建。

计费说明 数据加密 服务的计费项由密钥管理、凭据管理和专属加密等微服务费用组成，密钥对管理暂不收费。具体内容如表 数据加密服务计费项所示。 具体价格计算请参见数据加密服务价格详情。 表1 数据加密服务计费项 计费项 计费项规格 计费项说明 适用的计费模式 计费公式 密钥管理服务 自定义密钥 自定义密钥是用户自行通过KMS创建或导入的密钥。 按需计费 密钥实例费用 * 时长+密钥请求API次数 * API请求费用 默认密钥 默认密钥是 对象存储服务 （Object Storage Service，OBS）等其他云服务自动通过密钥管理为用户创建的用户主密钥，其别名后缀为“/default”。 按需计费 密钥请求API次数 * API请求费用 副本密钥 副本密钥是用户通过KMS在某一区域已有的主密钥下创建的副本密钥。与主密钥具有相同密钥材料。 按需计费 副本数量 * 实例费用 * 时长+密钥请求API次数 * API请求费用 凭据管理服务 通用凭据 通用凭据支持在各场景下进行自定义凭据的全生命周期管理。 按需计费 凭据实例费用 * 时长+凭据使用的密钥实例费用 * 时长+密钥请求API次数 * API请求费用 专属加密实例 标准版 专属加密（Dedicated Hardware Security Module，Dedicated HSM）是一种云上数据加密的服务，可处理加解密、签名、验签、产生密钥和密钥安全存储等操作。 包年/包月 实例规格单价 * 台数 * 购买时长 铂金版国内 包年/包月 初装费用 * 台数+实例规格单价 * 台数 * 购买时长

计费示例 假设您在2023/06/08 9:59:30创建了一个自定义密钥，然后在2023/06/08 10:45:46将其删除。计费周期内使用密钥进行API调用36594次，计费周期如下： 第一个计费周期为9:00:00 ~ 10:00:00，在9:59:30 ~ 10:00:00间产生费用，该计费周期内的计费时长为30秒。 第二个计费周期为10:00:00 ~ 11:00:00，在10:00:00 ~ 10:45:46间产生费用，该计费周期内的计费时长为2746秒。 图 按需计费KMS资源生命周期给出了上述示例配置的费用计算过程。 图中价格仅为示例，实际计算请以数据加密服务价格详情中的价格为准。 图1 按需计费密钥管理费用计算示例 按需计费模式下，各计费项的计费示例请参见计费示例。

计费示例 假设您在2023/06/08 9:59:30创建了一个自定义密钥，然后在2023/06/08 10:45:46将其删除。计费周期内使用密钥进行API调用36594次，计费周期如下： 第一个计费周期为9:00:00 ~ 10:00:00，在9:59:30 ~ 10:00:00间产生费用，该计费周期内的计费时长为30秒。 第二个计费周期为10:00:00 ~ 11:00:00，在10:00:00 ~ 10:45:46间产生费用，该计费周期内的计费时长为2746秒。 您需要为每个计费周期付费，各项资源单独计费，计费公式如表 计费公式所示。产品价格详情中标出了资源的每小时价格，您需要将每小时价格除以3600，得到每秒价格。 表2 计费公式 资源类型 计费公式 自定义密钥 密钥实例费用 * 时长+密钥请求API次数 * API请求费用

计费周期 按需计费KMS资源按小时计费，密钥实例费用每天结算一次（以UTC+8时间为准），密钥API请求费用每月结算一次（以UTC+8时间为准），结算完毕后进入新的计费周期。计费的起点以密钥创建成功的时间点为准，终点以密钥计划删除的时间点为准。 例如，您在8:45:30创建了一个自定义密钥，然后在9:40:08将其删除，则计费周期为8:00:00 ~ 10:00:00，在8:45:30 ~ 8:55:30间产生费用，该计费周期内的计费时长为600秒。

适用计费项 以下计费项支持按需计费。 表1 适用计费项 计费项 说明 密钥管理服务 按需创建的密钥实例费用以及密钥产生的API请求费用。 凭据管理服务 按需创建的凭据实例费用以及绑定密钥后产生的密钥API请求费用。 假设您创建了一个密钥算法为AES_256的对称密钥，在创建页面的底部，您将看到所需费用的明细，如图 费用示例所示。 图1 费用示例 费用计算将包括以下部分： 密钥实例费用：创建后的密钥按照时长计费。 API请求费用：创建密钥后按照API请求次数计费，每个密钥每月有20000次的免费请求次数。

产品功能 数字资产链服务支持以下功能： 表1 功能说明 规格 功能 说明 共享版 业务调用 通过SDK完成数字资产链的业务调用。 服务运营 查看API调用的统计监控，实时查看数字资产链实例的API调用、数字资产集合、数字资产发行、数字资产流转等相关数据。请参见图1。 资产检索 通过资产编码查看资产及资产所在集合的相关信息以及流转记录，如资产编码、集合名称、集合缩写、资产名称、资产类型、资产所有者地址、资产铸造者地址、铸造时间、转移时间、所在区块高度、交易hash值、销毁时间、销毁hash值等。请参见图2和图3。 说明： 销毁的资产，检索时不展示资产信息，只展示流转记录。 图中数据为测试数据，仅供参考。 数字资产浏览器 数字资产共享版浏览器，支持用户在未登录的情况下，查看共享版 区块链 中数字资产总发行数量、数字资产总流转次数、区块高度、总交易数等信息。同时也可以根据资产编码、交易哈希、区块哈希等值搜索对应数字资产详细信息、区块信息、交易信息以及流转记录等。请参见图4。 专享版 链管理 实时查看数字资产链实例运行状况，对实例做相应的操作。请参见图5。 单击实例名称可以查看实例的节点资源、网络分布及查询区块和交易信息。 资产管理 实时查看数字资产链实例的API调用、数字资产集合、数字资产发行、数字资产流转等相关数据。请参见图6。 合约仓库 统一展示和管理合约模板能力。请参见图7。 图1 共享版服务运营 图2 正常资产检索信息及流转记录 图3 销毁资产检索流转记录 图4 数字资产浏览器 图5 链概览 图6 专享版服务运营 图7 合约仓库 父主题： 数字资产链