华为云用户手册

  • IP查询 根据IP或 域名 返回IP所属区域和运营商。 输入参数 输入参数说明如表2所示。 表2 IP查询输入参数说明 参数 必填 说明 获取的ip或域名 是 获取的IP或域名。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表3。 表3 IP查询输出参数说明 参数 说明 状态码 状态码。 状态说明 状态说明。 Result 返回结果。 -ip IP地址。 -所在国家 所在国家。 -所在省份、州 所在省份、州。 -所在的城市 所在的城市。 -运营商 运营商。
  • 更多操作 创建版本完成后,您还可以执行如下表2所示的操作。 表2 更多操作 操作 说明 编辑版本 说明: 可编辑未发布的版本,不可编辑已发布的版本。 在“版本管理”页面的版本列表中,单击“操作”列的“编辑”。 在“编辑版本”页面,可编辑版本描述、版本类型、产能、版本开始时间和版本发布时间。 单击“提交”。 删除版本 说明: 可删除未发布的版本,不可删除已发布的版本。 删除版本后其名下全部内容将同步被清空,此操作无法恢复,请谨慎操作。 在“版本管理”页面的版本列表中,单击“操作”列的“删除”。 在“删除版本”对话框,根据界面提示在文本框输入“确定删除”,并勾选“我已知悉,强制删除”。 单击“确定”。
  • 删除多个数据表(多维表格) 输入参数 输入参数说明如表25所示。 表25 删除多个数据表(多维表格)输入参数说明 参数 必填 说明 删除的多条tableid列表 是 删除多个数据表的多条tableid列表。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表26。 表26 删除多个数据表(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。
  • 删除记录(多维表格) 根据指定数据表的记录ID删除记录。 输入参数 输入参数说明如表21所示。 表21 删除记录(多维表格)输入参数说明 参数 必填 说明 数据表id 是 数据表的ID。 单条记录的Id 是 单条记录的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表22。 表22 删除记录(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -是否成功删除 是否成功删除。 -删除的记录ID 删除的记录ID。
  • 列出数据表(多维表格) 输入参数 输入参数说明如表28所示。 表28 列出数据表(多维表格)输入参数说明 参数 必填 说明 分页标记 否 分页标记。 第一次请求不填,表示从头开始遍历。分页查询结果还有更多项时,会同时返回新的page_token,下次遍历可采用该page_token获取查询结果。 分页大小 否 分页大小。 最大值:100 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表29。 表29 列出数据表(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -是否还有更多项 是否还有更多项。 -分页标记 分页标记。 -总数 总数。 数据表信息 数据表信息。 -数据表id 数据表的ID。 -数据表的版本号 数据表的版本号。 -数据表名字 数据表的名字。
  • 列出记录(多维表格) 根据选择数据表列出数据表中所有记录信息。 输入参数 该执行动作无输入参数。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表27。 表27 列出记录(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -是否还有更多项 是否还有更多项。 -分页标记 分页标记。 -总数 总数。 记录信息 记录信息。 -记录id 数据表中记录的ID。 -fields 记录字段。
  • 检索记录(多维表格) 根据指定数据表中的记录ID检索记录。 输入参数 输入参数说明如表9所示。 表9 检索记录(多维表格)输入参数说明 参数 必填 说明 数据表id 是 数据表的ID。 单条记录的id 是 单条记录的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表10。 表10 检索记录(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -记录 记录。 -记录字段 记录字段。 -记录id 记录ID。 更新多条记录时必填。
  • 新增记录(多维表格) 根据选择数据表新增记录。 输入参数 输入参数说明如表15所示。 表15 新增记录(多维表格)输入参数说明 参数 必填 说明 数据表id 是 数据表的ID。 多行文本内容 是 多行文本内容。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表16。 表16 新增记录(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -记录 记录。 -记录id 记录ID。 更新多条记录时必填。 -记录字段 记录字段。
  • 更新记录(多维表格) 根据选择数据表更新记录(多维表格)。 输入参数 输入参数说明如表11所示。 表11 更新记录(多维表格)输入参数说明 参数 必填 说明 数据表id 是 数据表的ID。 单条记录的id 是 单条记录的ID。 新内容 是 新内容。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表12。 表12 更新记录(多维表格)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -记录 记录。 -记录字段 记录字段。 -记录id 记录ID。 更新多条记录时必填。
  • 新建在线文档 创建并初始化文档。 输入参数 输入参数说明如表13所示。 表13 新建在线文档输入参数说明 参数 必填 说明 文件夹token 否 文件夹token。 标题 否 标题。 正文内容 否 正文内容。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表14。 表14 新建在线文档输出参数说明 参数 说明 新建文档的token 新建文档的token。 新建文档的访问链接 新建文档的访问链接。
  • 添加文档评论 给指定文档添加评论。 输入参数 输入参数说明如表7所示。 表7 添加文档评论输入参数说明 参数 必填 说明 用户ID 否 文档评论的用户ID。 创建时间 否 创建评论时间。 更新时间 否 更新评论时间。 问题是否解决 否 问题是否解决。 解决问题的时间 否 解决问题的时间。 解决评论者的用户ID 否 解决评论者的用户ID。 评论内容 是 评论的内容。 文档token 是 评论文档的token。 文档类型 是 评论文档的类型。 文档 新版文档 用户ID类型 否 评论文档的用户ID类型。支持输入框和下拉列表两种模式。 open_id union_id user_id 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表8。 表8 添加文档评论输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 -评论ID 评论ID。 -创建时间 创建评论时间。 -是否已解决 评论问题是否已解决。 -评论里的回复列表 评论里的回复列表。 --回复列表 回复评论列表。 ---回复内容 回复评论的内容。 ----回复的内容 回复的具体内容。 ----文本内容 回复评论的文本内容。 ----回复的内容元素 回复的内容元素。 ---创建时间 回复评论的创建时间。 ---回复ID 回复评论的ID。 ---用户ID 回复评论的用户ID。 错误描述 错误描述。
  • 获取多维表格元数据 输入参数 该执行动作无需输入参数。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表6。 表6 获取多维表格元数据输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -多维表格元数据 多维表格元数据。 --多维表格的app_token 多维表格的app_token。 --多维表格的名字 多维表格的名字。 --多维表格的版本号 多维表格的版本号。 --多维表格是否已开启高级权限 多维表格是否已开启高级权限。
  • 获取文档纯文本内容(旧版) 获取文档的纯文本内容,不包含富文本格式信息。 输入参数 输入参数说明如表4所示。 表4 获取文档纯文本内容(旧版)输入参数说明 参数 必填 说明 文件的token 是 文件的token。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表5。 表5 获取文档纯文本内容(旧版)输出参数说明 参数 说明 错误码 错误码。 非0表示失败。 错误描述 错误描述。 -文档内容 文档内容。
  • 获取评论列表 获取在线文档的全文评论列表信息。 输入参数 输入参数说明如表2所示。 表2 获取评论列表输入参数说明 参数 必填 说明 文档token 是 文档token。 文档类型 是 文档类型 。支持输入框和下拉列表两种模式。 文档类型 电子表格类型 文件类型 新版文档类型 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表3。 表3 获取评论列表输出参数说明 参数 说明 错误码 错误码。 -是否还有更多项 在线文档评论是否还有更多项。 -分页标记 文档评论的分页标记。 -评论列表 文档评论的列表。 --评论ID 文档评论的ID。 --创建时间 文档评论的时间。 --是否已解决 文档评论是否已解决。 --评论里的回复列表 评论里的回复列表。 ---回复列表 文档评论的回复列表。 ---回复内容 回复内容。 ----回复内容 回复文档评论的内容。 -----文本内容 回复的文本内容。 -----回复的内容元素 回复的内容元素。 ----创建时间 创建时间。 ----回复ID 回复ID。 ----用户ID 用户ID。 错误描述 错误描述。
  • 网络流行语 根据输入的网络流行词,输出其来源和使用场景。 输入参数 用户配置网络流行语执行动作,相关参数说明如表2所示。 表2 网络流行语输入参数说明 参数 必填 说明 示例值/默认值 搜索词 是 输入一个网络流行词语。 YYDS 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参考表3。 表3 网络流行语输出参数说明 参数 说明 示例值/默认值 标题 输入的网络流行词语。 YYDS 内容 该流行语的来源以及使用场景。 YYDS即永远的神的缩写,常被粉丝用来赞赏自己的爱豆。在出圈以后,yyds的应用场景不断扩大,不仅可以用来赞美人物,也可以用来赞美喜欢的美食、事件等等。总之,一切皆可神yyds。
  • 修改扫描规则 输入参数 输入参数说明如表38所示。 表38 修改扫描规则输入参数说明 参数 必填 说明 规则类别 否 规则类别。 规则ID 否 规则ID。 逻辑运算符 否 逻辑运算符。 最小匹配次数 否 最小匹配次数。 风险等级 否 风险等级。 规则内容 否 规则内容。 规则描述 否 规则描述。 规则名称 否 规则名称。 规则类型 否 规则类型。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表39。 表39 修改扫描规则输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 修改告警通知主题 修改告警通知的关联项目ID、通知主题、通知状态(0为关闭通知,1为开启通知)等通用配置。 输入参数 输入参数说明如表40所示。 表40 修改告警通知主题输入参数说明 参数 必填 说明 告警通知状态 否 告警通知状态。 消息通知 主题的唯一资源标识符 否 消息通知主题的唯一资源标识符。 告警主题id 否 告警主题ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表41。 表41 修改告警通知主题输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 创建扫描任务 输入参数 输入参数说明如表36所示。 表36 创建扫描任务输入参数说明 参数 必填 说明 资产ID列表 否 资产ID列表。 扫描周期 否 扫描周期。 扫描任务名 否 扫描任务名 是否开启任务 否 是否开启任务。 规则组ID列表 否 规则组ID列表 扫描任务开始时间 否 扫描任务开始时间。 时区 否 时区。 主题的唯一资源标识符 否 主题的唯一资源标识符。 是否用nlp 否 是否用nlp。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表37。 表37 创建扫描任务输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 创建扫描规则 输入参数 输入参数说明如表34所示。 表34 创建扫描规则输入参数说明 参数 必填 说明 规则类别 否 规则类别。 规则ID 否 规则ID。 逻辑运算符 否 逻辑运算符。 最小匹配次数 否 最小匹配次数。 风险等级 否 风险等级。 规则内容 否 规则内容。 规则描述 否 规则描述。 规则名称 否 规则名称。 规则类型 否 规则类型。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表35。 表35 创建扫描规则输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 对数据进行脱敏 输入参数 输入参数说明如表27所示。 表27 对数据进行脱敏输入参数说明 参数 必填 说明 脱敏策略列表 否 脱敏策略列表。 需要脱敏的字段名称 否 需要脱敏的字段名称。 脱敏算法名称 否 脱敏算法名称。 脱敏算法参数 否 脱敏算法参数。 数据列表 否 数据列表。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表28。 表28 对数据进行脱敏输出参数说明 参数 说明 masked_data 脱敏后的数据列表。
  • 创建扫描规则组 输入参数 输入参数说明如表32所示。 表32 创建扫描规则组输入参数说明 参数 必填 说明 规则类别 否 规则类别。 规则组描述 否 规则组描述。 规则组名称 否 规则组名称。 包含的规则ID列表 否 包含的规则ID列表。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表33。 表33 创建扫描规则组输出参数说明 参数 说明 msg 返回消息。 status 返回状态。
  • 提取数据水印 输入参数 输入参数说明如表21所示。 表21 提取数据水印输入参数说明 参数 必填 说明 水印密钥 否 水印密钥。 字段类型列表 否 字段类型列表。 -数据的字段名称 否 数据的字段名称。 -数据的字段类型 否 数据的字段类型。 -标记该字段是否为主键 否 标记该字段是否为主键。 水印数据 否 水印数据。 -col 否 col。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表22。 表22 提取数据水印输出参数说明 参数 说明 watermarks 提取水印内容列表。
  • 查看规则列表 输入参数 输入参数说明如表19所示。 表19 查看规则列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 project_id 是 项目ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表20。 表20 查看规则列表输出参数说明 参数 说明 total 规则总数。 rules 规则列表。 -category 规则分类。 -delete_allowed 是否允许删除。 -group_names 分组名称。 -id 规则ID。 -logic_operator logic_operator -min_match min_match -risk_level 风险等级。 -rule_content 规则内容。 -rule_desc 规则描述。 -rule_name 规则名称。 -rule_type 规则类型。 -selected selected
  • 嵌入数据水印 输入参数 输入参数说明如表25所示。 表25 嵌入数据水印输入参数说明 参数 必填 说明 添加水印的内容 否 添加水印的内容。 水印密钥 否 水印密钥。 数据的字段名称 否 数据的字段名称。 数据的字段类型 否 数据的字段类型。 标记该字段是否为主键 否 标记该字段是否为主键。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表26。 表26 嵌入数据水印输出参数说明 参数 说明 嵌入水印后的数据 嵌入水印后的数据。 -item2 嵌入水印后的数据2。 -item1 嵌入水印后的数据1。
  • 查看资产列表 输入参数 该执行动作无需输入参数。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表18。 表18 查看资产列表输出参数说明 参数 说明 buckets OBS桶列表。 -asset_name 资产名称。 -bucket_location 桶位置。 -bucket_name 桶名称。 -bucket_policy 桶策略。 -create_time 创建时间。 -deleted 是否被删除。 -id 桶ID。 -is_deleted 是否被删除。 total OBS桶总数。
  • 查询扫描任务列表 输入参数 输入参数说明如表12所示。 表12 查询扫描任务列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 内容 否 内容。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表13。 表13 查询扫描任务列表输出参数说明 参数 说明 total 任务总数。 tasks 本次返回的扫描任务列表。 -id 任务ID。 -name 任务名称。 -cycle 任务执行方式。 -status 任务当前状态。 -open 任务开启状态。 -rule_groups 任务使用的规则组。 -last_run_time 任务上一次执行时间。 -create_time 任务创建时间。 -last_scan_risk 任务上一次扫描风险等级结果。 -use_nlp 是否使用了NLP进行扫描。 -topic_urn SMN 服务通知主题。 -start_time 任务扫描开始时间。
  • 查询OpenApi调用记录 输入参数 输入参数说明如表16所示。 表16 查询OpenApi调用记录输入参数说明 参数 必填 说明 分页大小 否 分页大小。 需要查询调用记录的URL 否 需要查询调用记录的URL。 开始时间 否 OpenApi调用的开始时间。 结束时间 否 OpenApi调用的结束时间。 指定标识符 否 指定标识符。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表17。 表17 查询OpenApi调用记录输出参数说明 参数 说明 total total succeed succeed failed failed openapi_called_records openapi_called_records -user_name user_name -user_id user_id -domain_name domain_name -domain_id domain_id -request_url request_url -request_method request_method -response_code response_code -fail_reason fail_reason -timestamp -timestamp next_marker next_marker
  • 查询告警通知主题 输入参数 输入参数说明如表14所示。 表14 查询告警通知主题输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表15。 表15 查询告警通知主题输出参数说明 参数 说明 default_topic_urn 默认消息通知主题的唯一资源标识符。 topic_count 已确认的消息通知主题数量。 topics 已确认的消息通知主题列表。 -name 消息通知主题名称。 -topic_urn 消息通知主题的唯一资源标识符。
  • 查询指定任务扫描结果 输入参数 输入参数说明如表8所示。 表8 查询指定任务扫描结果输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 资产类型 否 资产类型。 任务ID 是 指定任务的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表9。 表9 查询指定任务扫描结果输出参数说明 参数 说明 job_id job_id job_name job_name type type db_scan_result db_scan_result -total total -db_scan_results db_scan_results --task_id task_id --db_name db_name --table_id table_id --table_name table_name --risk_level risk_level --sensitive_data_type sensitive_data_type --match_info match_info ---column_name column_name ---rule_name rule_name ---rule_id rule_id ---rule_risk_level rule_risk_level ---column_line column_line
  • 查询扫描规则组列表 输入参数 输入参数说明如表10所示。 表10 查询扫描规则组列表输入参数说明 参数 必填 说明 页码 否 页码。 分页大小 否 分页大小。 输出参数 用户可以在之后的执行动作中调用该输出参数,输出参数说明请参见表11。 表11 查询扫描规则组列表输出参数说明 参数 说明 total total groups groups -id -ID -group_name group_name -group_desc group_desc -category category -rule_names rule_names -task_names task_names -delete_allowed delete_allowed -is_default is_default
共100000条