华为云用户手册

视频直播 有哪些计费项？如何知道自己需要支付哪些费用？ 视频直播计费项可以分为基础费用和增值费用，详情请参见计费项。 基础费用：流量/带宽费用，即您开启直播后，使用直播加速服务产生的流量/带宽费用。您可以在视频直播控制台的总览页自行选择按流量或带宽计费。 图1 计费方式 增值费用：包含录制、转码、截图等费用，这几项费用仅在您使用这些功能时才产生。 建议您在使用直播服务前，先根据业务的实际情况，购买直播套餐包。 父主题： 计费购买

操作指导 获取直播推流地址。 您可以在直播 域名 配置列表中单击“管理”获取直播推流URL，如图1所示。 图1 直播推流URL 以仅配置了播放域名场景的直播推流URL为例，推流URL的生成规则请参见查看推流URL。 按照软件安装向导安装好OBS软件。 配置OBS的关键参数。 单击右下角的“设置”，如图2所示。 图2 设置OBS参数 选择“输出”，将“输出模式”配置为“高级”，“关键帧间隔”配置为“2”，如图3所示。 图3 配置关键帧间隔 输入推流地址。 单击右下角的“设置”，如图4所示。 图4 设置OBS参数 选择“直播”，输入直播推流URL，如图5所示。 推流地址分两部分输入“服务器”和“推流码”中。直播推流URL规则请参见查看推流URL。 “服务器”填写包含直播推流URL中AppName前的地址。 “推流码”填写包含直播推流URL中StreamName后的地址。 图5 配置直播推流地址 单击“确定”，完成直播推流地址的配置。 启动直播推流任务。 在“来源”区域单击左下角的“+”，选择直播流来源，如图6所示。 图6 选择直播来源 媒体源：表示本地媒体文件。 视频采集设备：表示摄像头。 单击“开始直播”，开始推送直播流。

如何知道账户是否欠费？ 您可以登录华为云费用中心，在“总览”页面查看可用额度。 为了避免欠费导致的资源冻结，并请及时充值或备份数据以保证云资源的正常使用。建议您在费用中心设置“余额预警”。预警的金额，请根据历史资源使用情况估计。 在费用中心的“总览”页面，滑动“余额预警”参数后面的滑动按钮，即可开通或关闭余额预警功能。单击“修改”，可以对预警值进行修改。 开通后，当可用额度、通用代金券和现金券的总金额低于预警阈值时，系统自动发送短信通知提醒。 请用户在收到余额预警通知后，及时充值或者关闭不必要的资源，以免影响云资源的正常使用或者产生不必要的费用。 父主题： 计费购买

购买了直播CDN出流包，为什么还会从账户余额扣费？ 这可能是由于您的CDN计费方式为“按带宽计费”、“按月结95带宽峰值计费”或“按日峰值月平均计费”导致的。 建议您在视频直播控制台的总览页将计费方式变更为“按流量计费”。 不同计费方式的生效时间存在差异，如下所示： 若由“月结95带宽峰值计费”或“日峰值月均计费”变更为“流量计费”模式，则新的计费方式将在次月1日零点生效。 若由“带宽计费”变更为“流量计费”模式，则新的计费方式将在次日零点生效。 “按流量计费”模式生效后，即可使用直播CDN出流包了。 父主题： 计费购买

直播禁推和断流有什么区别？ 直播断流：由于网络故障等原因导致推流被中断，观众端将无法观看直播。直播断流后，建议主播端重新推流。 直播禁推：直播服务支持对某个直播流进行禁推操作，禁推后，本次直播会被中断，观众将无法继续观看直播。主播端在禁推时间内无法再次发起推流，禁推功能可通过视频直播控制台的“直播流管理”页面配置，禁推后的直播流展示于“禁推流”标签页，单击“恢复”后可恢复使用。 父主题： 直播推流

消息&短信MSG SMS 服务权限 默认情况下，新建的 IAM 用户没有任何权限，您需要将其加入用户组，并给用户组授予角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 消息&短信部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京四）对应的项目（cn-north-4）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问消息&短信时，需要先切换至授权区域。 权限根据角色进行授权。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 如表1 消息&短信服务系统角色所示，包括了消息&短信的所有系统策略。 表1 消息&短信服务系统角色 策略名称 描述 策略类别 依赖关系 RTC Administrator 语音通话、消息&短信、 隐私保护通话 的所有执行权限。 角色 无 MSGSMS FullAccess 消息&短信服务普通用户权限，拥有该权限的用户可以拥有消息&短信支持的全部权限，包括创建、删除、查询、变更规格等操作。 系统策略 无 MSGSMS ReadOnlyAccess 消息&短信服务只读权限，拥有该权限的用户仅能查看消息&短信服务数据。 系统策略 无 如表2所示，列出了短信服务操作与系统权限的授权关系，供您选择选择合适的系统权限。 表2 消息&短信MSGSMS操作与系统策略关系 操作 MSGSMS FullAccess MSGSMS ReadOnlyAccess 查询短信应用数量 √ √ 查询短信应用 √ √ 查询权限 √ √ 查询短信应用密钥 √ √ 查询租户受限原因 √ √ 查询签名信息 √ √ 查询短信类型 √ √ 查询签名名称 √ √ 查询短信模板 √ √ 查询催审配置 √ √ 查询校验租户订单状态 √ √ 查询开发者信息 √ √ 查询短信模板名称 √ √ 查询短信模板变量 √ √ 查看群发助手任务名称 √ √ 查询群发助手短信发送任务 √ √ 查看群发助手任务结果详情 √ √ 查询短信限额策略 √ √ 查询短信业务统计数据 √ √ 查询联系人 √ √ 查询历史请求信息 √ √ 查询短信总览统计数据 √ √ 查询消息提醒 √ √ 查询单条短信价格 √ √ 查询企业项目 √ √ 查询公共配置 √ √ 查询租户企业名称 √ √ 查询短信发送国家 √ √ 查看短信详情 √ √ 查询企业营业执照文件 √ √ 删除签名 √ x 删除短信模板 √ x 删除联系人 √ x 导出群发助手任务发送号码 √ x 导出短信业务统计数据 √ x 创建短信应用 √ x 发送验证码 √ x 添加签名 √ x 修改签名 √ x 签名申请催审 √ x 创建短信模板 √ x 导入群发助手短信发送任务 √ x 创建群发助手短信发送任务 √ x 添加联系人 √ x 新增解除黑名单请求 √ x 更新短信应用密钥 √ x 修改短信应用 √ x 申请激活签名 √ x 修改短信模板 √ x 更新群发助手定时任务 √ x 设置短信限额策略 √ x 修改联系人 √ x 批量导入短信模板 √ x 上传企业营业执照文件 √ x

约束与限制 IAM中的用户数、用户组数等有限定的配额， 其中“是否支持修改”列标示“√”的，表示该限制项可以修改。如果当前资源配额无法满足业务需要，您可以申请扩大配额，具体方法请参见：如何修改配额。 限制分类 限制项 限制值 是否支持修改 用户 IAM用户数 50 √ 用户名的字符数 32 x 用户可加入的用户组数 10 x 用户可创建的访问密钥（AK/SK）数 2 x 用户可绑定的虚拟MFA设备数 1 x 一个用户基于企业项目可绑定的权限数（包括系统权限和自定义策略） 500 √ 用户组 用户组数 20 √ 用户组名的字符数 128 x 一个用户组中可添加的用户数 账号下的IAM用户数 x 一个用户组基于IAM项目可绑定的权限数（包括系统权限和自定义策略） 200 √ 一个用户组基于企业项目可绑定的权限数（包括系统权限和自定义策略） 500 √ 项目 项目数 10 √ 策略 策略名称的字符数 128 x 自定义策略 自定义策略个数 200 √ 字符数 6144 x Statement 无限制 x Action 无限制 x Resource 无限制 x Condition 无限制 x 委托 委托数 50 √ 委托名称的字符数 64 x 一个委托可绑定的权限数（包括系统权限和自定义策略） 200 √ 身份提供商 数量 10 √ 名称字符数 64 x 账号中所有身份提供商的映射规则总数 10 √ 联邦虚拟用户绑定的用户组数 100 x 联邦虚拟用户的用户名的字符数 255 x

开通服务 访问“开通消息&短信服务”页面。 勾选“我已阅读并同意《消息&短信服务使用声明》”。 单击“立即开通”，提交业务审核。 工作日9:00-18:00（GMT+8:00）提交的申请，当天审核完毕，18:00后提交的申请，顺延至下一个工作日审核。 若单击“立即开通”无反应，您需要单击页面左上角“控制台”，切换区域至华北-北京四。 新用户首次开通短信服务，默认每天限额500条，超出额度后限制发送。如有提额诉求，请联系客户经理增加额度。 更多流程信息，请参考国内短信使用全流程。 控制台支持的浏览器版本，请参考浏览器兼容性。

开通服务异常现象及处理建议 异常现象 处理建议 提示“您尚未绑定邮箱，去绑定”。 请进入账号中心，查看是否已绑定注册邮箱。如果未绑定，请绑定后重试；如果已绑定，请修改绑定后重试 提示“检测到华为云账号变更，请联系客服进行资源的关联”。 请确认是否修改过华为云账号的账号名，修改回原账号名后重试，或提供修改前后的账号名，联系华为云客服处理。 提示“没有余额无法正常开通”。 账户欠费，请参考如何给账户充值，充值后再开通短信服务。 提示“暂不支持IAM用户开通服务，请使用主账号登录后开通服务”。 消息&短信暂只支持主账号开通服务，请使用主账号登录开通，授予子账号对应区域的消息&短信服务权限。 查询服务是否开通报错。 请检查账号实名认证信息，确认已通过华为云企业实名认证。请确认用户基本信息已完善，手机号已绑定。 国内短信请单击页面左上角“控制台”，切换区域至华北-北京四。 请确认已勾选“我已阅读并同意《消息&短信服务使用声明》”。 请清理浏览器缓存后重试。 单击“立即开通”无反应或页面未跳转。 无法单击“立即开通”（按钮呈灰色，不可单击）。 如有任何疑问，请联系华为云智能客服，将有专人为您解答。

响应示例 状态码： 200 OK { "total" : 1, "size" : 1, "items" : [ { "product_template_id" : null, "product_id" : 122893, "service_id" : 10190, "service_name" : "s1", "description" : null, "status" : 0, "created_user" : { "user_id" : "", "user_name" : "user" }, "last_updated_user" : { "user_id" : "", "user_name" : "user" }, "created_datetime" : 1607502702474, "last_updated_datetime" : 1607572282845 } ] } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services.queryService]. Parameter is [X-Auth-Token]. Processor is [header].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "SCB.00000000", "error_msg" : "Not Found", "request_id" : "624c8be1-39b6-47b7-941d-c159aced368a-1619602544650-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数。 最小值：1 最大值：99999999999999999 size Integer 本次返回数量。 最小值：1 最大值：999 items Array of Service objects 服务列表。 数组长度：0 - 9999 表5 Service 参数 参数类型 描述 product_template_id Integer 服务归属的产品模板ID。 最小值：1 最大值：99999999999999999 product_id Integer 服务归属的产品ID。 最小值：1 最大值：99999999999999999 service_id Integer 服务ID。 最小值：1 最大值：99999999999999999 service_name String 服务名称，支持中文、英文大小写、数字、下划线和中划线，长度2-64。 最小长度：2 最大长度：64 description String 服务描述，长度0-200。 最小长度：0 最大长度：200 status Integer 服务状态，0-启用，1-停用。 最小值：0 最大值：10 created_user CreatedUser object 创建时的用户。 last_updated_user LastUpdatedUser object 最后更新时的用户。 created_datetime Long 创建时间止，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 last_updated_datetime Long 最后修改时间止，格式timestamp(ms)，使用UTC时区。 最小值：1 最大值：99999999999999999 表6 CreatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 表7 LastUpdatedUser 参数 参数类型 描述 user_id String 用户ID(保留字段，未使用)。 最小长度：0 最大长度：64 user_name String 用户名。 最小长度：0 最大长度：64 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

响应示例 状态码： 200 OK { "content_type" : "json", "created_time" : "2020-09-18T09:25:59Z", "description" : "", "id" : "bd42841c20184da6bbf457c6d8a06e37", "instance" : "f0fa1789-3b76-433b-a787-9892951c620e", "method" : "GET", "modified_time" : "2020-09-18T09:25:59Z", "name" : "livedata_api_demo", "parameters" : [ ], "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "scripts" : [ ], "status" : 1, "type" : "", "version" : "1.0.1" } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 { "content_type" : "json", "method" : "GET", "name" : "livedata_api_demo", "path" : "/test/function", "return_format" : false, "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d", "version" : "1.0.1" }

响应示例 状态码： 400 Bad Request { "error_code" : "FDI.3150", "error_msg" : "The task list is empty." } 状态码： 404 Not Found { "error_code" : "FDI.3083", "error_msg" : "One or more scheduled tasks are not configured with scheduled plans." }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 success_count Integer 成功的个数。 最小值：0 最大值：999999 failure_count Integer 失败的个数。 最小值：0 最大值：999999 failure Array of TaskBeanFacade objects 失败的详情。 数组长度：0 - 999999 success Array of TaskBeanFacade objects 成功的任务信息。 数组长度：0 - 999999 表6 TaskBeanFacade 参数 参数类型 描述 task_id String 任务ID。 最小长度：1 最大长度：64 task_name String 任务名称。 最小长度：1 最大长度：64 error_code String 失败的错误码。 最小长度：0 最大长度：64 error_msg String 错误详情。 最小长度：1 最大长度：64 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 404 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度：8 最大长度：36 error_msg String 错误描述。 最小长度：2 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 action_id 是 String 操作类型。 start (启动) stop (停止) 最小长度：1 最大长度：10 list 否 Array of TaskBean objects 需要启动或者停止的任务ID列表，list数组长度最大为10。 数组长度：1 - 9999 表4 TaskBean 参数 是否必选 参数类型 描述 task_id 否 String 任务ID, 可为空。 最小长度：1 最大长度：64

URI GET /v1/{project_id}/link/instances/{instance_id}/topics 表1 参数说明 参数 类型 是否必填 说明 project_id string 是 租户每个区域对应的项目ID。 instance_id string 是 租户使用ROMA Connect的实例ID。 device_name string 是 根据输入的设备名称查询。 product_name string 是 根据输入的产品名称查询。

响应示例 状态码： 200 OK { "deploys" : { "api_id" : "1d0432f1a82a49d08b9308ae7bd96ca6", "deploy_time" : "2020-09-28T11:01:09Z", "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID", "group_id" : "01ce7564a2544713b80c7c08eb85f5d0", "id" : "abbe44b56eda428d84172343674c9cd6", "ld_api_id" : "bd42841c20184da6bbf457c6d8a06e37" } } 状态码： 400 Bad Request { "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3084", "error_msg" : "The livedata API does not exist, id: bd42841c20184da6bbf457c6d8a06e37" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

请求示例 为指定命令创建一个请求属性，数据类型为Integer，属性非必填，并设置最小和最大值。 { "property_name" : "power_usage", "description" : "power_usage", "data_type" : "integer", "required" : 0, "min" : "0", "max" : "100", "step" : "1", "unit" : "W" }

响应示例 状态码： 200 Created { "property_id" : 3320, "property_name" : "p2", "description" : null, "data_type" : "datetime", "required" : 0, "min" : 0, "max" : 65536, "step" : 1, "max_length" : "10", "unit" : "yuan", "enum_list" : null, "method" : "RWE" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-services-requests.saveCommandSend]. Parameter is [service_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 property_id Integer 属性ID。 最小值：1 最大值：99999999999999999 property_name String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 最小长度：2 最大长度：50 description String 属性描述，长度0-200。 最小长度：0 最大长度：200 data_type String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 最小长度：0 最大长度：10 required Integer 是否必填，0-非必填，1-必填。 最小值：0 最大值：10 min String 最小值，当data_type为integer或number时有效。 缺省值：0 最小长度：0 最大长度：10 max String 最大值，当data_type为integer或number时有效。 缺省值：65536 最小长度：0 最大长度：10 step String 步长，当data_type为integer或number时有效。 缺省值：1 最小长度：0 最大长度：10 max_length Integer 字符串最大长度，当data_type为string、datetime、json时有效。 最小值：1 最大值：99999999 缺省值：10 unit String 属性单位。 最小长度：0 最大长度：10 enum_list String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 最小长度：0 enum_dict Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 property_name 是 String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 最小长度：2 最大长度：50 description 否 String 属性描述，长度0-200。 最小长度：0 最大长度：200 data_type 是 String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 required 是 Integer 是否必填，0-非必填，1-必填。 最小值：0 最大值：10 min 否 String 最小值，当data_type为integer或number时必填。 缺省值：0 最小长度：0 最大长度：10 max 否 String 最大值，当data_type为integer或number时必填。 缺省值：65536 最小长度：0 最大长度：10 step 否 String 步长，当data_type为integer或number时必填。 缺省值：1 最小长度：0 最大长度：10 max_length 否 Integer 字符串最大长度，当data_type为string、datetim、 json时必填，自动向下取整。 最小值：1 最大值：999999 缺省值：10 unit 否 String 属性单位。 最小长度：0 最大长度：50 enum_list 否 String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 最小长度：0 enum_dict 否 Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 method 否 String 访问模式（兼容20.0，R属性可读，W属性可写，E属性可执行）。 最小长度：1 最大长度：3

响应参数 状态码： 201 表4 响应Body参数 参数 参数类型 描述 property_id Integer 属性ID。 最小值：1 最大值：99999999999999999 property_name String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 最小长度：2 最大长度：50 description String 属性描述，长度0-200。 最小长度：0 最大长度：200 data_type String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 最小长度：0 最大长度：10 required Integer 是否必填，0-非必填，1-必填。 最小值：0 最大值：10 min String 最小值，当data_type为integer或number时有效。 缺省值：0 最小长度：0 最大长度：10 max String 最大值，当data_type为integer或number时有效。 缺省值：65536 最小长度：0 最大长度：10 step String 步长，当data_type为integer或number时有效。 缺省值：1 最小长度：0 最大长度：10 max_length Integer 字符串最大长度，当data_type为string、datetime、json时有效。 最小值：1 最大值：99999999 缺省值：10 unit String 属性单位。 最小长度：0 最大长度：10 enum_list String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 最小长度：0 enum_dict Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 method String 访问模式（兼容20.0，R属性可读，W属性可写，E属性可执行）。 最小长度：1 最大长度：3 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 系统错误码，针对4xx和5xx类HTTP错误码的详细错误码。 最小长度：0 最大长度：64 error_msg String 错误描述。 最小长度：0 最大长度：200 request_id String 消息ID。 最小长度：0 最大长度：64

请求示例 为指定服务添加一个属性，数据类型为Integer，属性非必填，并设置最小和最大值。 { "property_name" : "power_usage", "description" : "power_usage", "data_type" : "integer", "required" : 0, "min" : "0", "max" : "100", "step" : "1", "unit" : "W" }

响应示例 状态码： 201 Created { "property_id" : 3320, "property_name" : "p2", "description" : null, "data_type" : "datetime", "required" : 0, "min" : 0, "max" : 65536, "step" : 1, "max_length" : "10", "unit" : "yuan", "enum_list" : null, "method" : "RWE" } 状态码： 400 Bad Request { "error_code" : "SCB.00000000", "error_msg" : "Parameter is not valid for operation [romalink.link-command.saveProperty]. Parameter is [service_id]. Processor is [path].", "request_id" : "cb39e78a-afd3-4e04-901d-70468b1c23dc-1619602712496-cnnorth7a-P-romalink-service01" } 状态码： 404 Not Found { "error_code" : "ROMA.00110006", "error_msg" : "The resource does not exist. Check whether the resource ID 1 is correct.", "request_id" : "13984193-ca65-4954-9b7f-4b7d680399d6-1619678681445-cnnorth7a-P-romalink-service01" } 状态码： 500 Internal Server Error { "error_code" : "ROMA.00110002", "error_msg" : "The instance does not exist. project_id: 397cd10b30544c588b2f4a56d83856c4, instance_id: f3bb386a-23ec-47aa-9943-4c60ac658611", "request_id" : "c8c06d0a-be92-4fdf-9d10-bc20131ab158-1619593104919-cnnorth7a-P-romalink-service01" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：100000 表3 请求Body参数 参数 是否必选 参数类型 描述 property_name 是 String 属性名称，首位必须为字母，支持大小写字母、数字、中划线及下划线，长度2-50。 最小长度：2 最大长度：50 description 否 String 属性描述，长度0-200。 最小长度：0 最大长度：200 data_type 是 String 属性数据类型，boolean枚举值大小写敏感；number格式为数字，范围±1.0 x 10^-28 to ±7.9228 x 10^28；string为字符串；integer为整数；datetime为时间，格式为yyyyMMddTHHmmss；json为自定义json格式； array为数组类型。 required 是 Integer 是否必填，0-非必填，1-必填。 最小值：0 最大值：10 min 否 String 最小值，当data_type为integer或number时必填。 缺省值：0 最小长度：0 最大长度：10 max 否 String 最大值，当data_type为integer或number时必填。 缺省值：65536 最小长度：0 最大长度：10 step 否 String 步长，当data_type为integer或number时必填。 缺省值：1 最小长度：0 最大长度：10 max_length 否 Integer 字符串最大长度，当data_type为string、datetim、 json时必填，自动向下取整。 最小值：1 最大值：999999 缺省值：10 unit 否 String 属性单位。 最小长度：0 最大长度：50 enum_list 否 String string的枚举值数组，使用逗号分隔，单个长度取决于max_length参数。 最小长度：0 enum_dict 否 Object 当数据类型为boolean枚举值时填写json格式数据，形如"enum_dict":{"0":"xxx","1":"xxx"}。 method 否 String 访问模式（兼容20.0，R属性可读，W属性可写，E属性可执行）。 最小长度：1 最大长度：3

请求示例 https://{endpoint}/v2/{project_id}/mqs/instances/{instance_id}/topics/{topic_name}/access-policies/batch-add { "policies" : [ { "user_name" : "62034763-c4aa-416f-975d-1452ba90fec2", "app_name" : "app-uve7", "access_policy" : "sub", "tag" : "123&abc" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 policies 是 Array of PolicyEntity objects 应用Topic权限列表。 表4 PolicyEntity 参数 是否必选 参数类型 描述 user_name 是 String 应用Key（access key） app_name 是 String 应用名称。 access_policy 是 String 权限类型。 all：拥有发布、订阅权限； pub：拥有发布权限； sub：拥有订阅权限。 tag 否 String 标签列表，权限类型对应的标签。 当权限类型是all时，发布和订阅的标签用符号“&”隔开。 当有多个标签时，标签用符号“||”隔开。 规则：仅能包含数字、字母、中划线（-）、下划线（_），长度不超过48。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String Topic名称，以字母开头，仅能包含数字、字母、下划线(_)、中划线（-），长度3-200字符。 app_id 是 String 集成应用Key。 app_key 否 String 集成应用Key。 partition 否 Integer Topic分区数，设置消费的并发数。 取值范围：1-100。 默认值：3。 replication 否 Integer 副本数，配置数据的可靠性。 取值范围：1-3。 默认值：3。 说明： 消息集成轻量化版的副本数只能为1。 基础版的取值范围： 1-3。 专业版/高性能设备接入版（一百万）取值范围： 1-5。 高性能设备接入版（一千万）取值范围：1-8。 access_policy 是 String 权限类型。 all：发布+订阅 pub：发布 sub：订阅 sync_message_flush 否 Boolean 是否使用同步落盘。默认值为false。同步落盘会导致性能降低。 sync_replication 否 Boolean 是否开启同步复制，开启后，客户端生产消息时相应的也要设置acks=-1，否则不生效，默认关闭。 retention_time 否 Integer 消息老化时间。默认值为72。取值范围1~168，单位小时。 tag 否 String 权限类型对应的标签。 当权限类型是all时，发布和订阅的标签用符号“&”隔开。 当有多个标签时，标签用符号“||”隔开。 description 否 String 描述。长度0-1000字符。 sensitive_word 否 String 敏感字段。 当有多个敏感字段时，敏感字段用符号“||”隔开。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 name String Topic名称。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误信息。