华为云用户手册

  • 责任共担 华为云秉承“将公司对网络和业务安全性保障的责任置于公司的商业利益之上”。针对层出不穷的 云安全 挑战和无孔不入的云安全威胁与攻击,华为云在遵从法律法规业界标准的基础上,以安全生态圈为护城河,依托华为独有的软硬件优势,构建面向不同区域和行业的完善云服务安全保障体系。 安全性是华为云与您的共同责任,如图1所示。 华为云:负责云服务自身的安全,提供安全的云。华为云的安全责任在于保障其所提供的IaaS、PaaS和SaaS类云服务自身的安全,涵盖华为云数据中心的物理环境设施和运行其上的基础服务、平台服务、应用服务等。这不仅包括华为云基础设施和各项云服务技术的安全功能和性能本身,也包括运维运营安全,以及更广义的安全合规遵从。 租户:负责云服务内部的安全,安全地使用云。华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、 虚拟主机 和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施,包括云安全战略、责任共担模型、合规与隐私、安全组织与人员、基础设施安全、租户服务与租户安全、工程安全、运维运营安全、生态安全。 图1 华为云安全责任共担模型 父主题: 安全
  • 支持审计的关键操作列表 云审计 服务(Cloud Trace Service, CTS ),是云安全解决方案中专业的日志审计服务,提供对各种云资源操作记录的收集、存储和查询功能,可用于支撑安全分析、合规审计、资源跟踪和问题定位等常见应用场景。 云审计支持的专属主机操作如表1所示。 表1 云审计支持的专属主机操作列表 操作名称 资源类型 事件名称 创建专属主机 dedicatedHosts createDedicatedHosts 更新专属主机 dedicatedHosts updateDedicatedHosts 删除专属主机 dedicatedHosts releaseDedicatedHosts 父主题: 关键操作审计
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 详细的公共请求消息头字段请参见表3。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息,从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口,https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型(格式)。推荐用户使用默认值application/json,有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度,单位为Byte。 否 3495 X-Project-Id project id,项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求,或者多project场景采用AK/SK认证的接口请求,则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头(Headers)中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注:以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证,AK/SK认证使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求消息体(可选) 该部分可选。请求消息体通常以结构化格式(如JSON或XML)发出,与请求消息头中Content-Type对应,传递除请求消息头之外的内容。若请求消息体中的参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-1”,您可以从地区和终端节点获取。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": $USER_NAME, # 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "password": $PASSWORD, # 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": $DOMAIN_NAME, # 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 } } } }, "scope": { "project": { "name": $PROJECT_NAME, # 建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成: {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器 域名 或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如 IAM 服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径,即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“?limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源,如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内,12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名,在请求时将签名信息添加到消息头,从而通过身份认证。 AK(Access Key ID):访问密钥ID。与私有访问密钥关联的唯一标识符;访问密钥ID和私有访问密钥一起使用,对请求进行加密签名。 SK(Secret Access Key):私有访问密钥。与访问密钥ID结合使用,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,您可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。
  • Token认证 Token的有效期为24小时,需要使用一个Token鉴权时,可以先缓存起来,避免频繁调用。 Token在计算机系统中代表令牌(临时)的意思,拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中,从而通过身份认证,获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": $USER_NAME, # IAM用户名,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "password":$PASSWORD, # IAM用户密码,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 "domain": { "name": $DOMAIN_NAME, # IAM用户所属账号名,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 } } } }, "scope": { "project": { "name": $PROJECT_NAME, # 项目名称,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全 } } } } 获取Token 后,再调用其他接口时,您需要在请求消息头中添加“X-Auth-Token”,其值即为Token。例如Token值为“ABCDEFJ....”,则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可,如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证:https://bbs.huaweicloud.com/videos/101333。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”,请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type:消息体的类型(格式),必选,默认取值为“application/json”,有其他取值时会在具体接口中专门说明。 X-Auth-Token:用户Token,可选,当使用Token方式认证时,必须填充该字段。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 API同时支持使用AK/SK认证,AK/SK认证是使用SDK对请求进行签名,签名过程会自动往请求中添加Authorization(签名认证信息)和X-Sdk-Date(请求发送的时间)请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的账号名称,********为用户登录密码,xxxxxxxxxxxxxxxxxx为project的名称,如“cn-north-4”,您可以从地区和终端节点获取,对应地区和终端节点页面的“区域”字段的值。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源,详细定义请参见获取用户Token。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 URI-scheme: 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint: 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path: 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string: 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,同一个服务的Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求示例 通过form表单提交请求,其中file是具体文件。 POST /v1/{project_id}/sdg/doc/watermark/embed { "file" : "test.doc", "doc_type" : "WORD", "opacity" : "0.1", "font_size" : "30", "rotation" : "45", "blind_watermark" : "blind_watermark", "visible_watermark" : "visible_watermark" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取(响应消息头中X-Subject-Token的值) 表3 FormData参数 参数 是否必选 参数类型 描述 doc_type 是 String 要嵌入水印的文档类型 枚举值: WORD EXCEL PDF PPT file_password 否 String 输入文件有密码时,读取文件的密码, 最大支持长度256。如果Office文档有读密码或域控的权限密码,请输入读密码,或者有读权限的域控密码。 marked_file_password 否 String 添加水印后给文件设置密码, 最大支持长度256。默认不加文档密码。 readonly_password 否 String 添加水印后给文件设置只读密码, 最大支持长度256。默认不加只读密码。 visible_watermark 否 String 明水印内容,与“blind_watermark”字段至少有一个不为空 font_size 否 String 明水印字体大小,取值为[1,100],默认值50 rotation 否 String 明水印旋转角度,逆时针方向,取值为[0,90],默认值45 opacity 否 String 明水印的透明度,取值[0,1],默认值为0.3; blind_watermark 否 String 暗水印内容,与“visible_watermark”字段至少有一个不为空 file 是 File 要添加水印的文档 image_mark 否 File 图形水印的字节流。图形文件的格式必须为“png”或“jpg”,否则返回参数错误;图像文件大小不超过1MB;在分段的请求体“Content-Disposition”部分,参数“name”的值必须为“image_mark”。 visible_type 否 String 该字段为空时,默认为TEXT类型。 当该字段为IMAGE时: 请求的表单中必须包含名为“image”的图像文件,图像格式必须为“png”或“jpg”,否则返回参数错误; 图像文件大小不超过1MB; “visible_watermark”,“font_size”,“rotation”和“opacity”字段无效。 枚举值: TEXT IMAGE
  • 请求参数 表1 请求参数 参数 是否必选 参数类型 描述 algorithm 是 String 算法类型,PRESNM parameters 是 parameters Object 脱敏算法参数 表2 parameters 参数 是否必选 参数类型 描述 type 是 String 掩盖字符串的方式,取值如下: CHAR:字符掩盖 RAND:随机掩盖 method 是 String 掩盖参数,若type字段为“RAND”时,method取值只能为: CHAR:替换为字母 DIGITAL:替换为数字 BOTH:数字与字母混合替换 n 是 Int 保留前n位字符 m 是 Int 保留后m位字符
  • 请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "PRESNM", "parameters": { "type": "CHAR", "n": 1, "m": 1, "method": "*" } } ], "data": [ { "col1": "test" } ] } 或: { "mask_strategies": [ { "name": "col1", "algorithm": "PRESNM", "parameters": { "type": "RAND", "n": 1, "m": 1, "method": "BOTH" } } ], "data": [ { "col1": "test" } ] }
  • 请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "KEYWORD", "parameters": { "key": "关键字", "target": "目标字符串" } } ], "data": [ { "col1": "关键字" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 region_id String 当前项目所在region的id,如:xx-xx-1。 image_watermark String 提取出的水印图片存放地址,当前只支持OBS对象,格式为 obs://bucket/object ,其中bucket为和当前项目处于同一区域的OBS桶名称,object为对象全路径名。例如:obs://hwbucket/hwinfo/hw.png,其中obs://表示OBS存储,hwbucket为桶名,hwinfo/hw.png为对象全路径名。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求示例 提取obs://bucket/info/wm.png路径下的图片中的图片暗水印,将提取的水印图片存放在obs://bucket/watermarkfile/mark.png路径下。 POST /v1/{project_id}/obs-image/image-watermark/extract HTTP/1.1 { "region_id" : "xx-xx-1", "src_file" : "obs://bucket/info/wm.png", "image_watermark" : "obs://bucket/watermarkfile/mark.png" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务“获取用户Token接口”获取(响应消息头中X-Subject-Token的值) 表3 请求Body参数 参数 是否必选 参数类型 描述 region_id 是 String 项目所在region的id,如:xx-xx-1。 src_file 是 String 待提取图片暗水印的图片地址,当前只支持OBS对象,格式为 obs://bucket/object ,其中bucket为和当前项目处于同一区域的OBS桶名称,object为对象全路径名。例如:obs://hwbucket/hwinfo/hw.png,其中obs://表示OBS存储,hwbucket为桶名,hwinfo/hw.png为对象全路径名。 image_watermark 是 String 提取出来的水印图片存放地址,格式要求同src_file。
  • 请求样例 { "mask_strategies": [ { "name": "col1", "algorithm": "MASKXY", "parameters": { "type": "CHAR", "x": 1, "y": 1, "method": "*" } } ], "data": [ { "col1": "test" } ] } 或: { "mask_strategies": [ { "name": "col1", "algorithm": "MASKXY", "parameters": { "type": "RAND", "x": 1, "y": 1, "method": "CHAR" } } ], "data": [ { "col1": "test" } ] }
  • 请求参数 表1 请求参数 参数 是否必选 参数类型 描述 algorithm 是 String 算法类型,MASKXY parameters 是 parameters Object 脱敏算法参数 表2 parameters 参数 是否必选 参数类型 描述 type 是 String 掩盖字符串的方式,取值为: CHAR:字符掩盖 RAND:随机掩盖 method 是 String 掩盖参数,若type字段为“RAND”时,method取值只能为: CHAR:替换为字母 DIGITAL:替换为数字 BOTH:数字与字母混合替换 x 是 Int 掩盖字符的开始位置 y 是 Int 掩盖字符的结束位置
  • 响应消息体(可选) 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "xxxxxxxx", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error": { "message": "The request you have made requires authentication.", "title": "Unauthorized" } } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 响应示例 状态码: 200 请求成功 { "total" : 1, "groups" : [ { "id" : "xxxxxxxxxxxx", "group_name" : "xxxx", "group_desc" : "xxxx", "category" : "private", "rule_names" : "xxxx", "is_default" : false } ] } 状态码: 400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total Integer 规则组总数 groups Array of ResponseGroup objects 规则组列表 表4 ResponseGroup 参数 参数类型 描述 category String 规则类别,内置规则(BUILT_IN)或自建规则(BUILT_SELF) 枚举值: BUILT_IN BUILT_SELF delete_allowed Boolean 是否允许删除 group_desc String 规则组描述 group_name String 规则组名称 id String 规则组ID rule_names String 规则名称 task_names String 扫描任务名称 is_default Boolean 是否为默认规则组 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息
  • 请求示例 创建规则名称为xxxx的自建规则,逻辑运算符选择AND,其中最小匹配值为1、风险等级为1、规则内容为xxxx、规则描述为xxxx、规则类型为KEYWORD。 POST /v1/{project_id}/sdg/server/scan/rules { "category" : "BUILT_SELF", "logic_operator" : "AND", "min_match" : 1, "risk_level" : 1, "rule_content" : "xxxx", "rule_desc" : "xxxx", "rule_name" : "xxxx", "rule_type" : "KEYWORD" }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 category 是 String 规则类别,内置规则(BUILT_IN)或自建规则(BUILT_SELF) 枚举值: BUILT_IN BUILT_SELF id 否 String 规则ID logic_operator 是 String 逻辑运算符,"AND","OR","REGEX" min_match 是 Integer 最小匹配次数 risk_level 是 Integer 风险等级 rule_content 是 String 规则内容 rule_desc 否 String 规则描述 rule_name 是 String 规则名称 rule_type 是 String 规则类型,关键字(KEYWORD)、正则表达式(REGEX)或自然语言(NLP) 枚举值: KEYWORD REGEX NLP
  • 请求示例 在中国区域xxxxxxxxxxxx项目购买2个月的hws.service.type.sdg云服务实例,该产品支持XX个数据库或者obs的扫描量。 POST /v1/{project_id}/period/order { "charging_mode" : 0, "cloud_service_type" : "hws.service.type.sdg", "is_auto_renew" : 0, "period_num" : 1, "period_type" : 2, "region_id" : "xxxxxxxxxxxx", "zone" : "CH", "product_infos" : [ { "cloud_service_type" : "hws.service.type.sdg", "product_id" : "xxxxxxxxxxxx", "resource_size" : 30, "resource_size_measure_id" : 30, "resource_spec_code" : "base_professional", "resource_type" : "hws.resource.type.dsc.base" } ] }
  • 请求参数 表2 请求Body参数 参数 是否必选 参数类型 描述 charging_mode 是 Integer 计费模式,0:包周期计费,1:按需计费,2:一次性计费 cloud_service_type 是 String 云服务类型 composite_product_id 否 String 组合套餐ID discount_id 否 String 折扣ID is_auto_renew 否 Integer 是否自动续费 period_num 是 Integer 订购周期数目 period_type 是 Integer 订购周期类型,2:月,3:年 product_infos 是 Array of ProductInfoBean objects 产品信息列表 promotion_activity_id 否 String 促销ID promotion_info 否 String 促销信息 region_id 是 String 当前项目所在region的id,如:xx-xx-1。 zone 是 String 所属国家区域 表3 ProductInfoBean 参数 是否必选 参数类型 描述 all_resource_names 否 Array of strings 资源名称列表 cloud_service_type 是 String 云服务类型 display_id 否 String 展示ID product_id 是 String 产品ID product_spec_desc 否 String 产品规格描述 resource_name 否 String 资源名称 resource_size 是 Integer 产品支持的数据库数量,或者支持obs的扫描量 resource_size_measure_id 是 Integer 资源容量度量标识,枚举值举例如下:15:mbps(购买带宽时使用),17:gb(购买云硬盘时使用),14:个/次 resource_spec_code 是 String 产品编码 resource_type 是 String 资源类型 usage_factor 否 String 已使用系数 usage_measure_id 否 Integer 已使用容量度量标识 usage_value 否 Double 已使用值
  • 响应示例 状态码: 200 OK { "job_id" : "xxxxxx", "job_name" : "xxxxxx", "type" : "DATABASE", "db_scan_result" : { "total" : 1, "db_scan_results" : [ { "task_id" : "xxxxxx", "db_name" : "xxxxxx", "table_id" : "xxxxxx", "table_name" : "student", "risk_level" : 6, "sensitive_data_type" : [ "xxxxxx", "xxxxxx" ], "match_info" : [ { "column_name" : "phone", "rule_name" : "xxxxxx", "rule_id" : "xxxxxx", "rule_risk_level" : 6, "column_line" : [ 1, 3 ] }, { "column_name" : "email", "rule_name" : "xxxxxx", "rule_id" : "xxxxxx", "rule_risk_level" : 1, "column_line" : [ 1, 3 ] } ] } ] }, "obs_scan_result" : null, "es_scan_result" : null } 状态码: 400 无效请求 { "error_code" : "dsc.40000011", "error_msg" : "Invalid parameter" }
共100000条