华为云用户手册

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 String 通道号。 port_type=5时 ，长度必须为5 port_type=1或3，长度在21位内 最小长度：0 最大长度：21 port_type 是 Integer 通道号类型。 1：普通 3：前缀号段 5：后缀号段 最小值：1 最大值：5 sign 是 Array of strings 签名列表，最大长度为5。单个签名长度为2-18。 最小长度：2 最大长度：18 数组长度：0 - 5 sign_check 是 Integer 是否需要校验。 0：不校验 1：校验签名 说明： 当port_type为3或者5时，sign_check必须为1。 最小值：0 最大值：1 authorization_files 是 Array of strings 授权证明图片资源，支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M，最多支持5张。参数格式为：资源ID:资源URL，样例：3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png。 说明： 资源ID与资源URL对应上传智能信息服务号图片资源API返回的resource_id和resource_url。 数组长度：0 - 5

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data PortRegisterResponse object 注册通道号响应体。 表4 PortRegisterResponse 参数 参数类型 描述 data RegisterResult object 返回体。 表5 RegisterResult 参数 参数类型 描述 port String 通道号。 port_type Integer 通道号类型。 1：普通 3：前缀号段 5：后缀号段 sign Array of strings 签名列表，最大长度为5。 数组长度：0 - 5 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 app_name String 应用名称。 最小长度：1 最大长度：30 app_id String 应用ID。 最小长度：1 最大长度：50 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name 是 String 应用名称。 最小长度：1 最大长度：30 up_link_addr 否 String 上行回调地址。支持通信协议HTTPS/HTTP。 最大长度：255

请求示例 修改ID为2353cb25-c169-4e20-adcf-3517****0f9e的短信应用。 https://koomessage.myhuaweicloud.cn/v1/sms/apps/2353cb25-c169-4e20-adcf-3517****0f9e{ "app_name" : "应用2", "up_link_addr" : "https://www.huaweicloud.cn"}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 request_id 否 String 请求ID。 最小长度：0 最大长度：100 domain_id 否 String 租户ID。 最小长度：0 最大长度：100 callback_type 否 String 回调类型。 shortchain：短链 sms：短信 最小值：1 最大值：2 body 否 String 响应信息。 回调类型为智能信息单条发送/短链回调： callback_type为shortchain时，body为ShortChainCallback实体的json字符串。 callback_type为sms时，body为SmsCallback实体的json字符串。 回调类型为智能信息批量发送/短链回调： callback_type为shortchain时，body为ShortChainCallback实体数组的json字符串。 callback_type为sms时，body为SmsCallback实体数组的json字符串。 说明： 回执中的task_id可用于发送任务或解析任务关联，使用发送智能信息API发送智能短信，同一发送批次每一个手机号最多收到两次回执，一个发送结果回执，一个解析成功回执，两次回执可使用aim_url关联。 最小长度：0 最大长度：100 retry 否 Boolean 重试标识。 表3 ShortChainCallback 参数 是否必选 参数类型 描述 task_id 否 String 任务ID。 cust_flag 否 String 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。 tpl_id 否 String 智能信息模板ID，由9位数字组成。 aim_url 否 String 带URL地址的智能信息短链。 aim_code 否 String 不带URL地址前缀的智能信息编码。 status 否 Integer 生成状态。 0：成功 非0：失败，具体请参见错误码 describe 否 String 对应返回的回执错误码的描述内容。 表4 SmsCallback 参数 是否必选 参数类型 描述 task_id 否 String 任务ID。 cust_flag 否 String 客户ID。 msg_id 否 String 发送明细的唯一标识ID。 tpl_id 否 String 智能信息模板ID，由9位数字组成。 sms_sign 否 String 短信签名。 aim_code 否 String 不带URL地址前缀的智能信息编码。 aim_url 否 String 带URL地址的智能信息短链。 send_time 否 String 短信发送时间。 receive_time 否 String 短信接收时间。 send_status 否 String 发送状态码。 说明： “DELIVRD”代表短信发送成功，其余状态码请参考短信服务错误码表。 send_status_desc 否 String 发送状态描述。 total 否 String 长短信拆分后的短信条数。 当短信未拆分时该参数取值为1。 sequence 否 String 长短信拆分后的短信序号。 当total参数取值大于1时，该参数才有效。当短信未拆分时该参数取值为1。 extend 否 String 扩展字段。 用户可以在发送短信的请求中携带该参数，如果用户发送短信时未携带extend参数，状态报告就不会携带该参数。

请求示例 定义短信回执。租户ID为"8f263a05a2294c62af09cfeccbd1cccc"，回执类型为"sms"。 https://koomessage.myhuaweicloud.cn/v1/aim/send-status{ "request_id" : "6b65e1ae-3e6e-45d3-8aab-05821b540000", "domain_id" : "8f263a05a2294c62af09cfeccbd1cccc", "callback_type" : "sms", "body" : "{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"msg_id\":\"e0ef4e00-xxxx-xxxx-ba33-4173156e657f\",\"tpl_id\":\"600000001\",\"sms_sign\":\"签名\",\"aim_code\":\"qTs3DC\",\"aim_url\":\"km2n.cn/qTB3DC\",\"send_time\":\"2022-06-01T09:00:49\",\"receive_time\":\"2022-06-01T09:00:49\",\"send_status\":\"Deliverd\",\"send_status_desc\":\"发送成功\"}", "retry" : false} 定义短信批量回执。租户ID为"8f263a05a2294c62af09cfeccbd1cccc"，回执类型为"sms"。 https://koomessage.myhuaweicloud.cn/v1/aim/send-status{ "request_id" : "6b65e1ae-3e6e-45d3-8aab-05821b39j313", "domain_id" : "8f263a06a2294c62af09cfeccbd1cccc", "callback_type" : "sms", "body" : "[{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"msg_id\":\"e0ef4e00-xxxx-xxxx-ba33-4173156e657f\",\"tpl_id\":\"600000001\",\"sms_sign\":\"签名\",\"aim_code\":\"qTs3DC\",\"aim_url\":\"km2n.cn/qTB3DC\",\"send_time\":\"2022-06-01T09:00:49\",\"receive_time\":\"2022-06-01T09:00:49\",\"send_status\":\"Deliverd\",\"send_status_desc\":\"发送成功\"}]", "retry" : false} 定义短链回执。租户ID为"8f263a06a2294c62af09cfeccbd1cccc"，回执类型为"shortchain"。 https://koomessage.myhuaweicloud.cn/v1/send-status{ "request_id" : "6b65e1ae-3e6e-44d3-8aab-05821b540000", "domain_id" : "8f263a06a2294c62af09cfeccbd1cccc", "callback_type" : "shortchain", "body" : "{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"tpl_id\":\"600000001\",\"aim_url\":\"km2n.cn/qTB3DC\",\"aim_code\":\"qTs3DC\",\"status\":0,\"describe\":\"发送成功\"}", "retry" : false} 定义短链批量回执。租户ID为"8f263a06a2294c62af09cfeccbd1cccc"，回执类型为"shortchain"。 https://koomessage.myhuaweicloud.cn/v1/send-status{ "request_id" : "6b65e1ae-3e6e-44d3-8aab-05821b540000", "domain_id" : "8f263a06a2294c62af09cfeccbd1cccc", "callback_type" : "shortchain", "body" : "[{\"task_id\":\"1869bbfb86e148adbcc068af3793cccc\",\"cust_flag\":\"131****0001\",\"tpl_id\":\"600000001\",\"aim_url\":\"km2n.cn/qTB3DC\",\"aim_code\":\"qTs3DC\",\"status\":0,\"describe\":\"发送成功\"}]", "retry" : false}

响应示例 状态码： 200 返回信息。 { "resolve_tasks" : [ { "task_id" : "30d6db9b-cc8a-4dc9-a314-d80d3fd0dbea", "task_name" : "ZF2", "tpl_id" : "600000001", "sms_signs" : [ "华为云 KooMessage " ], "resolving_times" : 1, "resolved_times" : 1, "aim_code_type" : "individual", "domain" : "km2g.cn", "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0001", "cust_id" : "231724915a62455ca356e10a085ccccc", "dync_params" : { "param3" : "参数3", "param4" : "参数4", "param1" : "参数1", "param2" : "参数2" }, "custom_url" : "https://www.example.com", "aim_url" : "km2g.cn/PDiWqc", "aim_code" : "PDiWqc", "result_code" : "0", "error_message" : "-", "generate_date" : "2022-07-18T21:00:56", "expire_date" : "2022-07-25T21:00:56", "resolved_date" : "2022-07-21T11:43:00" } ] }, { "task_id" : "30d6db9b-cc8a-4dc9-a314-d80d3fd0dbea", "task_name" : "ZFJ1", "tpl_id" : "600000001", "sms_signs" : [ "华为云KooMessage" ], "resolving_times" : 1, "resolved_times" : 0, "aim_code_type" : "individual", "domain" : "km2g.cn", "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0000", "cust_id" : "231724915a62455ca356e10a085ccccc", "dync_params" : { "param3" : "参数3", "param4" : "参数4", "param1" : "参数1", "param2" : "参数2" }, "custom_url" : "https://www.example.com", "aim_url" : "km2g.cn/PDeag3", "aim_code" : "PDeag3", "result_code" : "0", "error_message" : "-", "generate_date" : "2022-07-18T21:00:56", "expire_date" : "2022-07-25T21:00:56", "resolved_date" : null } ] } ], "page_info" : { "offset" : 0, "limit" : 2, "total" : 80 }}

URI GET /v1/aim/resolve-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_id 否 String 解析任务ID。 最小长度：0 最大长度：36 task_name 否 String 任务名称。 最小长度：0 最大长度：30 tpl_id 否 String 智能信息模板ID。 最小长度：0 最大长度：9 tpl_name 否 String 智能信息模板名称。 最小长度：0 最大长度：100 cust_flag 否 String 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。 发送智能信息时则必须填客户的手机号码。样例为：130****0001。 最小长度：0 最大长度：100 aim_url 否 String 完整的短链连接地址。样例：km2g.cn/PDiWqc。 begin_time 否 String 智能信息解析任务创建开始时间。格式为：2019-10-12T07:20:50.522Z。 说明： 需同时传入end_time才能生效，单独传begin_time不会作为过滤条件。 若不填，则默认查询24小时内创建的解析任务。 仅支持查询最近1年内创建的解析任务。 最小长度：0 最大长度：30 end_time 否 String 智能信息解析任务创建结束时间。格式为：2019-10-12T07:20:50.522Z。 说明： 需同时传入begin_time才能生效，单独传end_time不会作为过滤条件。 若不填，则默认查询24小时内创建的解析任务。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 说明： 为提高查询效率，offset+limit须小于等于10000，超出范围查询为空。 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_id 否 String 应用ID，默认取签名所属的应用ID。 最小长度：1 最大长度：50 signature_id 是 String 签名ID。 最小长度：1 最大长度：50 template_content 是 String 模板内容。 最小长度：1 最大长度：500 template_desc 否 String 模板描述。 最小长度：1 最大长度：100 template_name 是 String 模板名称。 最小长度：1 最大长度：30 template_type 否 String 模板类型。默认取所属签名的签名类型。 最小长度：1 最大长度：20 枚举值： PROMOTION_TYPE：营销类 NOTIFY_TYPE：通知类 universal_template 否 String 是否为通用模板(暂不支持通用模板)。 缺省值：0 最小长度：1 最大长度：10 枚举值： 0：非通用模板 1：通用模板 variable_attributes 是 Array of VariableAttributes objects 模板参数。 数组长度：1 - 20 表4 VariableAttributes 参数 是否必选 参数类型 描述 variable_index 是 Integer 参数索引。 variable_type 是 String 参数类型。 最小长度：1 最大长度：20 枚举值： PHONE：电话号码 NEWTEXT：解析标识 CHARDIGIT：其他号码(如验证码、订单号、密码等) DATETIME：日期时间 MONEY：金额 TEXT：其他 variable_desc 否 String 参数描述。变量类型为TEXT（其他）时必填。 最小长度：0 最大长度：100

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 template_id String 模板ID。 最小长度：1 最大长度：50 template_name String 模板名称。 最小长度：1 最大长度：30 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

请求示例 修改ID为"1512***3"的短信模板。 https://koomessage.myhuaweicloud.cn/v1/sms/templates/1512***3{ "signature_id" : "65ba0c56-aa84-4e68-86a7-38af62c50707", "template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ", "template_desc" : "模板测试", "template_name" : "模板测试AAB", "template_type" : "NOTIFY_TYPE", "universal_template" : 0, "variable_attributes" : [ { "variable_index" : 1, "variable_type" : "NEWTEXT", "variable_desc" : "直发" } ]}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data VmsCallBackList object 响应数据。 表3 VmsCallBackList 参数 参数类型 描述 callbacks Array of VmsCallBack objects 回执接口列表。 表4 VmsCallBack 参数 参数类型 描述 url_type Integer 回调类型。 0：发送状态回执 1：上行消息回执 callback_url String 回调地址。 remark String 备注。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : { "callbacks" : [ { "url_type" : 1, "callback_url" : " https://www.example.com/vms/reply-callback", "remark" : "上行消息回执" }, { "url_type" : 0, "callback_url" : " https://www.example.com/vms/send-callback", "remark" : "发送状态回执" } ] }}

响应示例 状态码： 200 查询智能信息基础版任务列表返回体。 { "status" : "200", "message" : "success", "data" : { "aim_basic_send_tasks" : [ { "task_id" : "dcda9636-b30f-473c-af88-c8ea2ccccccc", "task_name" : "回落", "task_state" : "发送中", "tpl_id" : "800000003", "tpl_name" : "测试-年中福利", "operator" : "hwstaff_KMSG_Customer2", "create_time" : "2022-06-07T01:00:15Z", "send_time" : "2022-06-07T01:00:15Z", "total_count" : 1, "success_count" : 0, "failed_count" : null, "timeout_count" : null, "exdata" : null }, { "task_id" : "975d83c2-8b26-4a98-b758-76b88efccccc", "task_name" : "0606ceshi003", "task_state" : "发送完成", "tpl_id" : "800000004", "tpl_name" : "测试- 华为云产品 欢迎您", "operator" : "hwstaff_KMSG_Customer2", "create_time" : "2022-06-06T02:02:23Z", "send_time" : "2022-06-06T02:02:23Z", "total_count" : 3, "success_count" : 3, "failed_count" : null, "timeout_count" : null, "exdata" : null } ], "page_info" : { "offset" : 0, "limit" : 2, "total" : 27 } }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data VMSSendTasks object 查询智能信息基础版发送任务列表响应。 表4 VMSSendTasks 参数 参数类型 描述 aim_basic_send_tasks Array of VMSSendBody objects 智能信息基础版任务查询列表。 数组长度：0 - 100 page_info Page object 分页信息。 表5 VMSSendBody 参数 参数类型 描述 task_id String 智能信息基础版任务ID。 task_name String 智能信息基础版任务名称。 task_state String 智能信息基础版任务状态。 tpl_id String 智能信息基础版模板ID。 tpl_name String 智能信息基础版模板名称。 operator String 操作员。 create_time String 智能信息基础版任务创建时间。 send_time String 智能信息基础版任务发送时间。 total_count Integer 需要发送的手机号码总数（有效号码总数）。 success_count Integer 已经发送成功的手机号码总数。 failed_count Integer 已经发送失败的手机号码总数。 timeout_count Integer 已经发送超时失败的手机号码总数（72小时没接收到状态认定为超时失败）。 exdata String 扩展字段。 说明： 预留字段。 表6 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

URI GET /v1/aim-basic/send-tasks 表1 Query参数 参数 是否必选 参数类型 描述 task_name 否 String 智能信息基础版任务名称。 task_id 否 String 智能信息基础版任务ID。 tpl_id 否 String 智能信息基础版模板ID。 tpl_name 否 String 智能信息基础版模板名称。 begin_time 否 String 智能信息基础版任务创建开始时间。 样例为：2019-10-12T07:20:50Z。 end_time 否 String 智能信息基础版任务创建结束时间。 样例为：2019-10-12T07:20:50Z。 send_begin_time 否 String 智能信息基础版任务发送开始时间。 样例为：2019-10-12T07:20:50Z。 send_end_time 否 String 智能信息基础版任务发送结束时间。 样例为：2019-10-12T07:20:50Z。 operator 否 String 操作员。 task_status 否 String 发送状态类型。 submit_success：提交成功 submit_failed：提交失败 processing：发送中 sending_failed：发送失败 re_submit_success：重试提交成功 sending_complete：发送完成 re_submit_failed：重试提交成功 re_processing：重试进行中 re_sending_complete：重试发送完成 scheduled：定时任务 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：2147483647 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 data PortalPushResponseBody object 主页催审返回体。 表3 PortalPushResponseBody 参数 参数类型 描述 data data object 消息体。 表4 data 参数 参数类型 描述 log_id String 主页申请记录ID。 message String 返回信息。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : { "page_info" : { "offset" : 1, "limit" : 2, "total" : 185 }, "results" : [ { "id" : "2bb938ae-33d0-4429-a849-458e650b9d76", "created_at" : "2022-06-01 23:13:09.0", "resource_type" : "image", "file_name" : "2_cropped_ducky.jpg", "aim_resource_id" : "691996319597764608", "obs_object_key" : "2_cropped_ducky-698756331828305.jpg", "obs_file_url" : "https://cn-north-4-km-template.obs.cn-north-4.myhuaweicloud.com:443/2_cropped_ducky-698756331828305.jpg?AccessKeyId=NTC2D0Y60ZYE54XXT23R&Expires=1655431901&Signature=FatQpd3PHMjMV5KaDzxaySseLKI%3D", "image_rate" : "oneToOne", "description" : null, "thumbnail" : null }, { "id" : "9ce7491f-b991-4789-95ed-d4ca2b505c73", "created_at" : "2022-06-01 23:13:08.0", "resource_type" : "image", "file_name" : "2_cropped_ducky.jpg", "aim_resource_id" : "691996313788653569", "obs_object_key" : "2_cropped_ducky-698683534539006.jpg", "obs_file_url" : "https://cn-north-4-km-template.obs.cn-north-4.myhuaweicloud.com:443/2_cropped_ducky-698683534539006.jpg?AccessKeyId=NTC2D0Y60ZYE54XXT23R&Expires=1655431901&Signature=P6xQaLtJkW7mpd1b2Mwde3Zmv2k%3D", "image_rate" : "oneToOne", "description" : null, "thumbnail" : null } ] }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data ListTemplateMaterialResponse object 返回模板素材列表。 表4 ListTemplateMaterialResponse 参数 参数类型 描述 page_info PageInfo object 分页信息。 results Array of Material objects 模板素材列表。 数组长度：0 - 100 表5 PageInfo 参数 参数类型 描述 offset Integer 翻页页数，从1开始。 limit Integer 每页展示的条数。 total Integer 总条数。 表6 Material 参数 参数类型 描述 id String 素材ID。 created_at String 创建时间。 resource_type String 资源类型。 image：表示图片 video：表示视频 thumbnail：表示缩略图 file_name String 文件名称。 aim_resource_id String 资源ID。 obs_object_key String 从OBS返回的文件Key。 obs_file_url String 文件访问路径。 obs_bucket_name String OBS桶名称。 image_rate String 图像比例。 oneToOne：指1:1比例 sixteenToNine：指16:9比例 threeToOne：指3:1比例 fortyEightToSixtyFive：指48:65比例 twentyOneToNine：指21:9比例 threeToFour：指3:4比例 description String 素材详细描述。 thumbnail Thumbnail object 文件缩略图。 domain_id String 租户ID。 size Integer 素材所占空间大小。 表7 Thumbnail 参数 参数类型 描述 id String 缩略图ID。 created_at String 创建时间。 is_primary Integer 是否作为视频素材封面。 0：否 1：是 resource_type String 资源类型，image：表示图片。 file_name String 文件名称。 aim_resource_id String 资源ID。 obs_object_key String 从OBS返回的文件Key。 obs_file_url String 文件访问路径。 image_rate String 图像比例。 oneToOne：指1:1比例 sixteenToNine：指16:9比例 threeToOne：指3:1比例 fortyEightToSixtyFive：指48:65比例 twentyOneToNine：指21:9比例 threeToFour：指3:4比例 is_auto_gen Integer 缩略图是否自动从系统生成。 description String 缩略图的详细描述。 size Integer 缩略图所占空间大小。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

URI GET /v1/aim/template-materials 表1 Query参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型。 image：表示图片 video：表示视频 最小长度：1 最大长度：16 file_name 否 String 文件名称。 最小长度：0 最大长度：100 material_id 否 String 素材ID。 最小长度：0 最大长度：36 aim_resource_id 否 String 资源ID。 最小长度：0 最大长度：64 offset 是 Integer 翻页页数，从1开始。 最小值：1 最大值：1000 limit 是 Integer 每页展示的条数。 最小值：1 最大值：1000

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 file_id String 文件ID。 最小长度：1 最大长度：50 file_name String 文件名称。 最小长度：1 最大长度：64 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

处理办法 通过报错信息查看报错表。例如：tablet writer write failed, tablet_id=27xxx2, txn_id=285xxx20, err=[-235] 。 show table tablet_id; 查看表各副本的情况。结果中versionCount字段表示版本数量，如果副本版本过多，则需要降低导入数据的频率或者停止导入。 show proc "/dbs/..."; 此处命令使用步骤1运行结果DetailCmd字段对应的值。

CloudTable集群能够提供什么服务？ 表格存储服务 （CloudTable Service，简称CloudTable）为用户提供专属集群，即开即用，适合业务吞吐量大，时延要求低的用户。 CloudTable提供基于HBase全托管的NoSQL服务，提供毫秒级随机读写能力，适用于海量（半）结构化、时空、时序数据存储，可被广泛应用于物联网、车联网、金融、智慧城市、气象等行业。 CloudTable提供基于Doris全托管的实时数仓服务，仅需亚秒级响应时间即可返回海量数据下的查询结果，不仅可以支持高并发的点查询场景，也可以支持高吞吐的复杂分析场景。因此，Doris能够较好的满足报表分析、即席查询、统一数仓构建、 数据湖 联邦查询加速等使用场景，用户可以在此之上构建用户行为分析、AB实验平台、日志检索分析、用户画像分析、订单分析等应用。 ClickHouse是一款开源的面向联机分析处理的列式数据库，其独立于Hadoop大数据体系，最核心的特点是压缩率和极速查询性能。同时，ClickHouse支持SQL查询，且查询性能好，特别是基于大宽表的聚合分析查询性能非常优异，比其他分析型数据库速度快一个数量级。 父主题： 通用类

CloudTable HBase中如何查询某个表的创建时间？ 在CloudTable中查询表的创建时间有如下方法： 创建新表的时候会显示在返回结果中。 连接集群，使用HBase Shell访问集群，具体操作请参见《用户指南》手册中的“使用HBase Shell访问集群”章节。 输入create命令，新建表。 create 'TEST','StuInfo','Grades' 返回结果如下：第一行代表表的创建时间和表名，第二行代表创建表所用的时间。 图1 建表 父主题： 连接访问类

处理方法 建议业务代码连接同一个CloudTable HBase集群时，多线程创建并复用同一个Connection，不必每个线程都创建各自Connection。Connection是连接CloudTable HBase集群的连接器，创建过多连接会加重Zookeeper负载，并损耗业务读写性能。多个客户端线程可以共享一个Connection，典型的用法是一个客户端程序共享一个单独的Connection。

使用CloudTable服务时需要关注什么？ 在CloudTable服务控制台，检查集群状态和任务状态，如果存在集群状态为“创建失败”或“亚健康”，请及时提交工单联系技术工程师解决；如果任务状态存在失败任务，请及时提交工单联系技术工程师解决。 在CloudTable服务控制台，单击“监控信息”进入 云监控 控制台，查看对应集群各项指标的监控信息，用户可以对关注的监控指标设定告警规则，如果存在告警，请及时提交工单联系技术工程师解决。如果集群CPU或内存使用率长时间超出阈值，那么用户需要扩容计算单元，均衡负载。 在CloudTable服务控制台，单击“集群管理”打开集群列表，指定集群名称查看集群已使用存储容量是否超过阈值，如果超出阈值，则用户需要扩容存储配额，增加存储容量。 父主题： 通用类

资源停止服务或逾期释放说明 用户购买产品后，如果没有及时续费或充值，将进入宽限期。如果宽限期满仍未续费或充值，将进入保留期。在保留期内资源停止服务。保留期仍未续费或充值，存储在云服务中的数据将删除、云服务资源将被释放。 宽限期是指客户的包年/包月资源到期未续订或按需资源欠费时，华为云提供给客户进行续费与充值的时间，宽限期内客户可正常访问及使用云服务。华为云将会通过邮件、短信等方式向您发送提醒，提醒您续费或充值。 保留期是指宽限期满后客户的包年/包月资源仍未续订或按需资源仍未缴清欠款，将进入保留期。保留期内客户不能访问及使用云服务，但对客户存储在云服务中的数据仍予以保留。华为云将会通过邮件、短信等方式向您发送提醒，提醒您续费或充值。 宽限期和保留期的详细说明请参见宽限期保留期。 父主题： 通用类

如何查看回收站数据 登录CloudTable控制台。 创建Doris集群。 连接Doris集群。 查看回收站数据。 show trash; 图1 回收站数据 恢复回收站数据。 curl -X POST http://{be_host}:{be_webserver_port} /api/restore_tablet?tablet_id={tablet_id}\&schema_hash={schema_hash} be_host：节点地址。 be_webserver_port：节点端口。

设置回收站时间 回收站原理：删除的数据不会直接从磁盘上删除，而是先放入回收站，等待超时时间满足后，再从磁盘上直接删除。 设置回收站时间需要考虑的因素。 回收站时间过长，会累积垃圾文件，占用磁盘空间。 回收站时间过长，调用admin clean trash;命令后，容易导致数据不均衡，触发二次数据均衡，再次产生垃圾文件。 回收站时间过短，容易误删、异常原因导致被删除的tablet无法被恢复。建议根据实际业务，观察回收站占用的磁盘空间的平均值，并根据占用磁盘空间和所需的防误删时间窗口，设置合理时间值。 curl -X POST http://{be_ip}:{be_http_port}/api/update_config?trash_file_expire_time_sec={value}\&persist=true be_host：节点地址。 be_webserver_port：节点端口。 trash_file_expire_time_sec：回收站清理的间隔，72个小时，当磁盘空间不足时，trash下的文件保存期可不遵守这个参数，默认值259200。