华为云用户手册

  • 概述 一种可排序数据类型的每一种表达式都有一个排序规则(系统内部的可排序数据类型可以是text、varchar和char等字符类型。用户定义的基础类型也可以被标记为可排序的,并且在一种可排序数据类型上的域也是可排序的)。如果该表达式是一个列引用,该表达式的排序规则就是列所定义的排序规则。如果该表达式是一个常量,排序规则就是该常量数据类型的默认排序规则。更复杂表达式的排序规则根据其输入的排序规则得来。
  • 连接类型介绍 通过SQL完成各种复杂的查询,多表之间的连接是必不可少的。连接分为:内连接和外连接两大类,每大类中还可进行细分。 内连接:标准内连接(INNER JOIN),交叉连接(CROSS JOIN)和自然连接(NATURAL JOIN)。 外连接:左外连接(LEFT OUTER JOIN),右外连接(RIGHT OUTER JOIN)和全外连接(FULL JOIN)。 为了能更好的说明各种连接之间的区别,下面通过具体示例进行详细的阐述。 创建示例表student和math_score,并插入数据,设置enable_fast_query_shipping为off(默认为on)即查询优化器使用分布式框架;参数explain_perf_mode为pretty(默认值为pretty)指定explain的显示格式。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 CREATE TABLE student( id INTEGER, name varchar(50) ); CREATE TABLE math_score( id INTEGER, score INTEGER ); INSERT INTO student VALUES(1, 'Tom'); INSERT INTO student VALUES(2, 'Lily'); INSERT INTO student VALUES(3, 'Tina'); INSERT INTO student VALUES(4, 'Perry'); INSERT INTO math_score VALUES(1, 80); INSERT INTO math_score VALUES(2, 75); INSERT INTO math_score VALUES(4, 95); INSERT INTO math_score VALUES(6, NULL); SET enable_fast_query_shipping = off; SET explain_perf_mode = pretty;
  • 多表查询中on条件和where条件的区别 从上面各种连接语法中可见,除自然连接和交叉连接外,其他都需要有on条件(using在查询解析过程中会被转为on条件)来限制两表连接的结果。通常在查询的语句中也都会有where条件限制查询结果。这里说的on连接条件和where过滤条件是指不含可以下推到表上的过滤条件。on和where的区别是: on条件是两表连接的约束条件。 where是对两表连接后产生的结果集再次进行过滤。 简单总结就是:on条件优先于where条件,在两表进行连接时被应用;生成两表连接结果集后,再应用where条件。
  • 响应示例 { "status": "200", "message": "success", "i18n": null, "data": { "ruleInfo": null, "headId": null, "expandRule": { "idPrefix": "0807", "headerSequence": "0001", "stepSize": 1, "createNum": 1, "tailSequence": "0001", "idSuffix": "", "numberRules": "10", "characterSet": "0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F,G,H,J,K,L,M,N,P,Q,R,S,T,U,V,W,X,Y,Z", "deHeaderSequence": 1, "deTailSequence": 1 }, "traceKey": null, "status": 30, "genId": "1792828105460658176", "genCode": "GEN0005", "genName": "Part分类生成器", "genClassName": null, "siteId": "-1", "objectAttrCode": null, "objectAttrValue": null, "createNum": null, "idList": [ "08070001" ], "code": null, "message": "success", "seqLength": null, "lastIdValue": null, "idGroupValue": null, "idSegmentValue": null, "tenantId": "PDM", "dataClass": null, "barcode": null, "parseInfo": null, "objJson": null, "genLabelCode": null, "genClassCode": null, "iconId": "975cbf40-8eed-4287-92a1-5886737b24ed" } }
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 genCode 是 String 生成器代码 objJson 否 JSONObject 编码生成器包含对象编码属性时使用,objJson里面的值是对象编码中定义的属性值,支持多个属性 "objJson": "{\"Category_Code\": \"0303\",\"Model_Number\": \"modelNumber\"}"
  • 区域和可用区/边缘可用区 华为云用区域和可用区来描述数据中心的位置,您可以在特定的区域、可用区购买桌面。 区域(Region):从地理位置和网络时延维度划分,同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region,通用Region指面向公共租户提供通用云服务的Region;专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区(AZ,Availability Zone):一个AZ是一个或多个物理数据中心的集合,有独立的风火水电,AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连,以满足用户跨AZ构建高可用性系统的需求。 图1阐明了区域和可用区之间的关系。 图1 区域和可用区 目前,华为云已在全球多个地域开放云服务,您可以根据需求选择适合自己的区域和可用区。
  • 桌面池 桌面池是一批同规格镜像桌面集合,它能为管理员提供该项目下一批桌面的统一管理和运维的能力。桌面池包含动态池、静态池两种类型。 动态池是指M:N的池类型的桌面组,该桌面池内的虚拟机与对应的虚拟机用户一直没有固定的分配绑定关系;虚拟机用户每次通过客户端登录该桌面池时,workspace会动态的从该桌面池中随机分配一台空闲的虚拟机给该用户使用。 静态池是指1:1的池类型的桌面组。该桌面池内的虚拟机与对应的虚拟机用户最初没有固定的分配绑定关系,当该池内某个虚拟机第一次登录使用时,这个虚拟机与用户的分配绑定关系就固定下来了,后续该用户登录该桌面组,都会分配同一台虚拟机供其使用的,此虚拟机不会再分配给其他用户使用。
  • 云桌面的计费方式 不同区域支持的计费类型可参考云桌面价格计算器,具体请以实际购买云桌面页面显示为准。 表5 云桌面计费方式 计费模式 计费方式 计费周期 包年/包月 先购买再使用,用户在购买时,系统会根据用户所选的套餐对用户云账户中的金额进行扣除。 计费周期以UTC+8时区的时间为准。计费周期的起点是资源开通的时间点(精确到秒),终点是指定使用时长后的第一个00:00:00。 按需计费 先使用后扣款,后台会依据用户在区间时间段内使用时长,对用户云账户中的金额进行扣除。 以整点小时为计费周期,计费周期以UTC+8时区的时间为准。使用过程中,系统在每个整点时间(如2:00:00,3:00:00)会自动出账单核算区间时间内使用时长所需费用。 订单到期后,提供7天的宽限期,宽限期内资源依然可用。 宽限期后,提供15天的保留期,保留期内资源不可用,但并未删除。 保留期后,如果您没有续费订单,资源将自动删除。
  • 计费规则: 按需购买的实例支持关机/休眠不计费,关机/休眠后的计费规则: 实例本身(vCPU,内存,镜像)不计费,其它所挂载的资源如云硬盘,公网IP或带宽则正常计费。 按需计费云桌面支持关机/休眠不计费,即关机/休眠期间,在保留云桌面的前提下,系统将自动回收计算资源(vCPU、内存)。此时,将不再收取计算资源相关费用,仅收取存储资源(系统盘和数据盘)费用,可以降低您的使用成本,再次启动时会重新申请vCPU和内存,在资源不足时会有启动失败的风险,您可以通过稍后启动或更改实例规格的方式来恢复。 按需计费的特殊实例不支持关机/休眠不计费。特殊实例关机/休眠后仍然正常收费,同时vCPU和内存等资源也会保留。 不支持关机不计费的特殊实例包括: 含本地盘的实例,如磁盘增强型实例、超高I/O型实例等。 公网/私网NAT网关根据您选择的公网NAT网关规格和使用时长计费。详细的价格说明请参考NAT网关价格计算器。 除特殊公共镜像,其他公共镜像为免费,如果公共镜像转为私有镜像,则会根据云市场价格收取镜像费用。 云桌面删除或者退订(具体操作请参考云桌面《用户指南》的“桌面退订”章节),桌面的弹性公网IP会自动解绑、弹性公网IP会继续保留并计费,请前往弹性公网IP页面手动删除。 应用中心中文件使用OBS存储时进行计费,详情参考 对象存储服务 OBS的计费说明。
  • 云桌面套餐 云桌面支持基于X86架构和基于鲲鹏架构的桌面套餐,您可以通过本章节快速浏览在售的所有规格清单,具体套餐请参见云桌面价格详情请以实际购买页面为准。 企业版和尊享版云桌面使用非绑定CPU调度模式,vCPU会根据系统负载被随机分配到空闲的CPU超线程上,当主机负载较大时,可能由于不同桌面vCPU争抢物理CPU资源而导致桌面性能波动不稳定。 企业版办公型如表1所示 表1 企业版套餐 套餐类型 套餐ID vCPU 内存 CPU架构 企业办公型-2U4GB workspace.x86.enterprise.large2 2核 4GB X86计算 企业办公型-2U8GB workspace.x86.enterprise.large4 2核 8GB X86计算 企业办公型-4U8GB workspace.x86.enterprise.xlarge2 4核 8GB X86计算 企业办公型-4U16GB workspace.x86.enterprise.xlarge4 4核 16GB X86计算 企业办公型-8U16GB workspace.x86.enterprise.2xlarge2 8核 16GB X86计算 企业办公型-8U32GB workspace.x86.enterprise.2xlarge4 8核 32GB X86计算 尊享版办公型如表2所示 表2 尊享版套餐 套餐类型 套餐ID vCPU 内存 CPU架构 尊享办公型-2U4G workspace.x86.ultimate.large2 2核 4GB X86计算 尊享办公型-2U8G workspace.x86.ultimate.large4 2核 8GB X86计算 尊享办公型-4U8G workspace.x86.ultimate.xlarge2 4核 8GB X86计算 尊享办公型-4U16G workspace.x86.ultimate.xlarge4 4核 16GB X86计算 尊享办公型-8U16G workspace.x86.ultimate.2xlarge2 8核 16GB X86计算 尊享办公型-8U32G workspace.x86.ultimate.2xlarge4 8核 32GB X86计算 鲲鹏计算型如所表3示 表3 鲲鹏计算型套餐 套餐类型 套餐ID vCPU 内存 CPU架构 鲲鹏基础办公型-2U4G workspace.k.large2.uosv20pro 2核 4GB 鲲鹏计算 鲲鹏基础办公增强型-2U8G workspace.k.large4.uosv20pro 2核 8GB 鲲鹏计算 鲲鹏通用办公型-4U8G workspace.k.xlarge2.uosv20pro 4核 8GB 鲲鹏计算 鲲鹏通用办公增强型-4U16G workspace.k.xlarge4.uosv20pro 4核 16GB 鲲鹏计算 鲲鹏高级办公型-8U16G workspace.k.2xlarge2.uosv20pro 8核 16GB 鲲鹏计算 鲲鹏高级办公增强型-8U32G workspace.k.2xlarge4.uosv20pro 8核 32GB 鲲鹏计算 各区域上线的套餐可能不同,请以实际购买页面为准。
  • 计费模式 云桌面的规格包括计算资源(vCPU 、内存)和存储资源(系统盘、数据盘)。您可以根据业务中接入用户规划及云桌面使用场景规划,来决定您购买云桌面实例规格、数量及区域分布,以便为您的用户提供最优质的云桌面服务。云桌面支持包年包月计费模式和按需计费模式供您灵活选择。 包年包月:华为云提供包月和包年的购买模式。这种购买方式相对于按需付费则能够提供更大的折扣,对于长期使用者,推荐该方式。包年/包月计费按照订单的购买周期来进行结算。 适用场景:适合稳定长期使用云桌面资源的场景,相对于按需付费则能够提供更大的折扣。 按需计费:按需申请云桌面资源使用,实例从“开通”开启计费到“删除”结束计费,按实际购买时长(精确到秒)计费即开即停,支持变更为包年/包月资源,具体详情参考云桌面《用户指南》的“桌面计费模式变更(按需转包周期)”章节。 适用场景:适合短期业务需求的场景使用,可按需开关机释放实例计算资源,节省成本。
  • 接入后验证 纳管实例完成后即表示已将数据库接入至AppStage,在实例列表中会显示已纳管的数据库实例,可根据以下内容验证是否接入成功。 在实例列表中查看数据库实例的运行状态、规格与华为云是否一致。 单击实例名称进入实例详情页面,查看实例详细信息是否准确。 在实例列表,单击数据库实例所在行“操作”列的“账号”,单击“治理账号”,在治理账号列表查看是否已创建治理账号。 包括数据查询账号(dbquery)、SQL变更账号(change) 和性能分析账号(monitor)。 纳管后用户无法再持有明文密码,如果需要紧急修改数据库时,可以通过在数据库实例详情页面申请账号,获取账号密码。
  • 录入华为公有云账号 进入运维中心工作台。 将鼠标悬停在右上角的账号,选择下拉列表中的“服务环境配置”,选择左侧导航栏的“账户列表”。 单击“录入账号”。 录入账号信息,具体参数如表1所示。 表1 账号信息参数 参数名称 参数说明 厂商 选择账号归属的云厂商。 华为公有云账号ID 使用华为云并购买资源时注册的账号的账号ID。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”,在“API凭证”页面查看。 华为公有云账号名称 使用华为云并购买资源时注册的账号的账号名。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”,在“API凭证”页面查看。 纳管方式 AK-SK:通过AKSK获取管理员IAM操作权限,该IAM账号所属用户组需要拥有对应的权限,不同接入资源所需的权限不同,具体如表2所示,授权操作请参见用户组授权。 接入CCE集群时,该集群还需要在华为云CCE控制台进行授权,具体操作如为CCE集群授权所示。 授权委托:将操作权限委托给AppStage,让AppStage以IAM身份使用其他云服务,代替IAM进行一些资源运维工作,具体操作请参见创建委托,其中委托的账号需要设置为AppStage平台账号“HIS_wiseEyes”。 说明: 在AppStage管理控制台订购页可根据提示完成服务委托授权,如果未授权或者资源管理账号和开通AppStage账号不一致,可以在账号管理中进行授权委托。 IAM用户ID 选择纳管方式为AK-SK时,显示此参数。在IAM中创建的用户的用户ID。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”,在“API凭证”页面查看。 IAM用户名 选择纳管方式为AK-SK时,显示此参数。在IAM中创建的用户的用户名。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”,在“API凭证”页面查看。 AK 选择纳管方式为AK-SK时,显示此参数。输入用户的华为云访问密钥ID。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“我的凭证”,在左侧导航栏单击“访问密钥”,在“访问密钥”页面查看AK。 SK 选择纳管方式为AK-SK时,显示此参数。输入用户的华为云访问密钥。 SK只能在第一次创建的时候下载,之后都不能通过管理台查询。 授权委托名称 选择纳管方式为授权委托时,显示此参数。输入用户在华为云创建委托的名称。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“统一身份认证”,在左侧导航栏单击“委托”,在委托列表查看。 授权委托ID 选择纳管方式为授权委托时,显示此参数。输入用户在华为云创建委托的ID。 获取方式:在华为云控制台,鼠标悬停在右上角的用户名,选择下拉列表中的“统一身份认证”,在左侧导航栏单击“委托”,在委托列表查看。 表2 权限说明 接入资源 服务 所需权限策略类型 所需权限 网络 弹性网络服务(ENS) 系统策略 VPC Administrator 网络管理员 VPCEndpoint Administrator VPC终端节点服务使您可以将VPC私密的连接到支持的服务 ELB FullAccess 弹性负载均衡服务所有权限 CES Administrator 云监控服务管理员 NAT FullAccess AT网关服务所有权限 Tenant Guest 云服务只读权限(除IAM权限) NAT Administrator NAT网关服务管理员 ELB ReadOnlyAccess 弹性负载均衡服务只读权限 ELB Administrator 弹性负载均衡服务ELB管理员 虚拟机 主机管理服务(VMS) 自定义策略 策略内容如下所示: { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "bms:*:*", "deh:*:*", "ecs:*:*", "evs:*:*", "ims:*:*", "cce:*:*", "mrs:*:*", "bss:*:*", "vpc:*:*" ] } ] } CCE集群 弹性资源服务(ERS) 系统策略 CCE Administrator CCE集群及集群下所有资源的读写权限 SFS Administrator 弹性文件服务的操作权限 APM FullAccess 应用性能管理服务的所有执行权限 OBS Administrator 对象存储服务管理员 SWR Admin 容器镜像服务的管理员权限 ELB Administrator 弹性负载均衡服务管理员 Server Administrator 服务器管理员 Tenant Guest 云服务只读权限(除IAM权限) 数据库 数据库治理(WiseDBA) 系统策略 不同数据库类型所需权限不同,具有如下: RDS(for MySQL) RDS FullAccess 关系型数据库服务所有权限 GeminiDB Cassandra GeminiDB FullAccess 分布式多模NoSQL数据库服务所有权限 GaussDB(for openGauss)/GaussDB(for MySQL) GaussDB FullAccess 云数据库GaussDB服务的所有执行权限 必选权限,无论使用哪种数据库,在数据库接入时都需要以下权限: DRS FullAccess 数据复制服务所有权限 VPC ReadOnlyAccess 虚拟私有云的只读权限 CES告警 资源管理(RMS) 自定义策略 策略内容如下所示: { "Statement": [ { "Action": [ "rms:resources:list", "rms:resources:get" ], "Effect": "Allow" } ], "Version": "1.1" } 单击“确定”。
  • 常用监控图表使用场景 表格:适用于多维度字段的指标统计。如图1所示,可以展示各接口下的总数、成功数、失败数、成功率、时延等数据。 图1 表格 折线图:适用于各维度的指标统计趋势对比。如图2所示,可以展示今昨对比的请求量趋势,如图3所示,可以展示各机房的请求量趋势。 图2 昨今对比折线图 图3 机房对比折线图 柱状图:适用于维度字段按照升序或降序的指标统计。如图4所示,可以展示下载次数的Top20。 图4 柱状图 饼图:适用于各维度的指标统计分布占比。如图5所示,可以展示Top5的错误码分布。 图5 饼图 地图:适用于各区域(国家、省份、城市等)维度指标的统计。如图6所示,可以展示各省份的下载次数分布。 图6 地图
  • 模板审核需要多长时间? 如果在法定工作日9:00~18:00期间提交审核的短信模板,国内文本短信模板一般在2小时内完成审核。 如果18:00后提交审核的短信模板,顺延至下一个工作日审核。仅支持工作日审核,法定节假日顺延。 如果超过规定时间仍未审核,您可登录短信控制台,进入“模板管理”页面,查找“待审核”的国内文本短信模板或国际/港澳台短信模板,单击“催审”。对于催审状态的模板申请,运营经理会优先处理,加快审核。 父主题: 模板问题
  • 注意事项 如果加速域名的资源在CDN节点不缓存,即使设置了状态码缓存时间,也无法缓存客户端请求该资源时产生的状态码。 后台有特殊配置的域名暂不支持配置状态码缓存时间。 业务类型为全站加速的域名不支持配置状态码缓存时间。 CDN默认缓存404、500、502、504状态码3s,其他状态码默认不缓存。 是否默认缓存404状态码依赖头域设置,如果带有X-HTTP-Method-Override、X-HTTP-Method、X-Method-Override头域,默认不缓存,反之则缓存3s。 如果域名的某个资源URL参数设置为“忽略参数”,当客户端请求返回的状态码(例如400)被缓存时,在缓存时间内所有该资源的请求均返回该状态码(400),请根据业务情况合理设置状态码缓存时间。 当前支持修改以下状态码的缓存时间: 4XX:400、403、404、405、414。 5XX:500、501、502、503、504。 3XX:301、302。
  • 适用场景 状态码缓存时间功能主要适用于源站响应异常状态码的场景。当源站运行正常时,CDN回源请求资源后将按照设置的缓存规则将资源缓存到节点,再次访问相同资源时不会触发回源。当源站响应异常,且不希望所有请求都由源站响应,可以设置状态码缓存时间,减轻源站压力。 典型应用:图片abc.jpg已从源站删除,CDN节点无缓存,且持续有用户在访问该资源,那么所有访问都将会回源,由源站响应4xx状态码,增加源站压力。此时如果在CDN配置4xx状态码缓存时间,用户再次请求资源将直接由CDN节点响应4xx状态码,无需回源。
  • 响应示例 状态码: 200 请求成功。 { "control_summaries" : [ { "manage_account_id" : "string", "control_identifier" : "string", "state" : "string", "version" : "string", "name" : "string", "description" : "string", "control_objective" : "string", "behavior" : "string", "owner" : "string", "regional_preference" : "string", "guidance" : "string", "service" : "string" } ], "state" : "string", "page_info" : { "next_marker" : "string", "description" : "本页返回条目数量。", "current_count" : 0 } }
  • URI GET /v1/governance/managed-organizational-units/{managed_organizational_unit_id}/controls 表1 路径参数 参数 是否必选 参数类型 描述 managed_organizational_unit_id 是 String 注册OU ID。 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页页面的最大值。 最小值:1 最大值:2000 缺省值:200 marker 否 String 页面标记。 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 control_summaries Array of TargetControl objects 治理策略概要。 page_info PageInfoDto object 本页返回条目数量。 表4 TargetControl 参数 参数类型 描述 manage_account_id String 管理纳管账号ID。 最小长度:1 最大长度:64 control_identifier String 控制策略标识。 最小长度:1 最大长度:128 state String 控制策略启用状态。 最小长度:1 最大长度:64 version String 控制策略当前版本号。 最小长度:1 最大长度:64 name String 控制策略名称。 最小长度:1 最大长度:64 description String 控制策略描述信息。 最小长度:1 最大长度:64 control_objective String 控制策略目标。 最小长度:1 最大长度:128 behavior String 控制策略类型。包括主动性控制策略Proactive、检测性控制策略Detective、预防性控制策略Preventive。 最小长度:1 最大长度:64 owner String 纳管账号的创建来源,包括CUSTOM和RGC。 最小长度:1 最大长度:128 regional_preference String 区域选项,取值有两种分别是:区域的regional和全局的global。 最小长度:1 最大长度:128 guidance String 控制策略必须性。 最小长度:1 最大长度:64 service String 控制策略所属服务。 最小长度:1 最大长度:64 implementation String 服务控制策略(SCP),配置规则。 最小长度:1 最大长度:64 表5 PageInfoDto 参数 参数类型 描述 next_marker String 在标签请求参数中使用以获取输出的下一部分。重复此操作,直到响应元素返回null。如果存在,则表示可用的输出比当前响应中包含的输出多。 current_count Integer 本页返回条目数量。
  • 获取账号、IAM用户、项目的名称和ID 从控制台获取账号名、账号ID、用户名、用户ID、项目名称、项目ID 在华为云首页右上角,单击“控制台”。 在右上角的用户名中选择“我的凭证”。 图1 进入我的凭证 在“我的凭证”界面,API凭证页签中,查看账号名、账号ID、用户名、用户ID、项目名称、项目ID。 每个区域的项目ID有所不同,需要根据业务所在的区域获取对应的项目ID。 图2 查看账号名、账号ID、用户名、用户ID、项目名称、项目ID 调用API获取用户ID、项目ID 获取用户ID请参考:管理员查询IAM用户列表。 获取项目ID请参考:查询指定条件下的项目列表。
  • 概述 欢迎使用资源治理中心(Resource Governance Center,简称RGC)。RGC是照规范性最佳实践提供一种简单的方案发设置和管理多账户环境,用户可以通过RGC服务创建一个Landing Zone,包含一个管理账号和多个成员账号,同时对这些账号进行各种自动化的护栏配置,帮助客户方便快速安全上云。 您可以使用本文档提供API对RGC进行相关操作,如创建、删除、更新、查询等。支持的全部操作请参见API概览。 在调用RGC的API之前,请确保已经充分了解RGC相关概念,详细信息请参见资源治理中心产品介绍。 父主题: 使用前必读
  • AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内,12M以上的请求请使用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不同,使用时请注意。
  • 状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如,切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 203 Non-Authoritative Information 非授权信息,请求成功。 204 NoContent 请求完全成功,同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容,服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置,相应可返回一个资源特征与地址的列表用于用户终端(例如:浏览器)选择。 301 Moved Permanently 永久移动,请求的资源已被永久的移动到新的URI,返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改,服务器返回此状态码时,不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码,表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件,服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大,服务器无法处理,因此拒绝请求。为防止客户端的连续请求,服务器可能会关闭连接。如果只是服务器暂时无法处理,则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长(URI通常为网址),服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确,但是由于含有语义错误,无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部,然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时(Timeout)参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本,无法完成处理。 父主题: 附录
  • 操作(Action) 操作(Action)即为策略中支持的操作项。 “访问级别”列描述如何对操作进行分类(list、read和write等)。此分类可帮助您了解在策略中相应操作对应的访问级别。 “资源类型”列指每个操作是否支持资源级权限。 资源类型支持通配符号*表示所有。如果此列没有值(-),则必须在策略语句的Resource元素中指定所有资源类型(“*”)。 如果该列包含资源类型,则必须在具有该操作的语句中指定该资源的URN。 资源类型列中必需资源在表中用星号(*)标识,表示使用此操作必须指定该资源类型。 “条件键”列包括了可以在策略语句的Condition元素中支持指定的键值。 如果该操作项资源类型列存在值,则表示条件键仅对列举的资源类型生效。 如果该操作项资源类型列没有值(-),则表示条件键对整个操作项生效。 如果此列没有值(-),表示此操作不支持指定条件键。 您可以在自定义策略语句的Action元素中指定以下RGC的相关操作。
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 control_operation ControlOperation object 控制策略实施的情况。 表3 ControlOperation 参数 参数类型 描述 operation_control_status_id String 本次操作控制策略的ID。 最小长度:1 最大长度:64 operation_type String 操作类型,启用控制策略或禁用控制策略。 最小长度:1 最大长度:64 status String 控制策略实施的状态 SUCCEEDED | FAILED | IN_PROGRESS。 最小长度:1 最大长度:64 message String 控制策略实施失败的错误信息。 最小长度:1 最大长度:2048 start_time String 操作开始的时间。 end_time String 操作结束的时间。
  • 响应示例 状态码: 200 请求成功。 { "control_operation" : { "operation_control_status_id" : "string", "operation_type" : "string", "status" : "string", "message" : "string", "start_time" : "string", "end_time" : "string" } }
  • 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 详细的公共响应消息头字段请参见表1。 表1 公共响应消息头 消息头名称 描述 Content-Type 资源内容的类型。 类型:String 默认值:无 Connection 指明与服务器的连接是长连接还是短连接。 类型:String 有效值:keep-alive | close。 默认值:无。 Date RGC服务响应的时间。 类型:String 默认值:无 X-Request-Id 由RGC创建来唯一确定本次请求的值,可以通过该值来定位问题。 类型:String 默认值:无
  • 响应消息体 响应消息体通常以结构化格式返回,与响应消息头中Content-type对应,传递除响应消息头之外的内容。 对于查询控制策略操作状态接口,返回如下消息体。 { "control_operation": { "operation_control_status_id": "c0jquihv-x3ve-1lb9-qmix-dankod8dg86z", "operation_type": "ENABLE_CONTROL", "status": "SUCCEEDED", "message": "", "start_time": "2024-04-19T16:26:30.518", "end_time": "2024-04-19T16:26:30.618" } } 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_msg": "error msg", "error_code": "APIGW.0301", "request_id": "string" } 其中,error_code表示错误码,error_msg表示错误描述信息。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在查询控制策略操作状态的URI部分,您可以看到其请求方法为“GET”,则其请求为: GET https://rgc.cn-north-4.myhuaweicloud.com/v1/governance/operation-control-status/{operation_control_status_id}
共100000条