华为云用户手册

请求消息 表2 请求参数说明 参数名称 是否必选 参数类型 说明 job_ids 是 Array of Long 作业ID。 trigger_savepoint 否 Boolean 在停止作业之前，用户可以选择是否对作业创建保存点，保存作业的状态信息。类型为boolean。 当triggerSavePoint为true时，表示创建保存点。 当triggerSavePoint为false时，表示不创建保存点。默认为false。

响应示例 { "is_success": true, "message": "导入作业成功", "job_mapping": [ { "old_job_id": "100", "new_job_id": "200", "remark": "Job successfully created" } ] }

响应消息 表3 响应参数说明 参数名称 是否必选 参数类型 说明 is_success 否 String 执行请求是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 job_mapping 否 Array of Objects 导入作业的信息。具体请参考表4。 表4 job_mapping参数说明 参数名称 是否必选 参数类型 说明 old_job_id 否 Long 导入的作业ID。 new_job_id 否 Long 导入后的作业ID，如果“is_cover”为“false”，服务中有同名的作业，则该参数返回值为“-1”。 remark 否 String 导入作业的结果信息。

请求示例 赋予某项目（项目ID：0732e57c728025922f04c01273686950）数据库db1的查询权限、数据表db1.tbl的删除权限、数据表指定列db1.tbl.column1的查询权限。 { "grant_project_id": "0732e57c728025922f04c01273686950", "action": "grant", "privileges": [ { "object": "databases.db1.tables.tb2.columns.column1", "privileges": ["SELECT"] }, { "object": "databases.db1.tables.tbl", "privileges": ["DROP_TABLE"] }, { "object": "databases.db1", "privileges": ["SELECT"] } ] } 赋予某用户dlitest的数据库dbtest的查询数据权限。 { "action": "grant", "privileges": [ { "object": "databases.dbtest", "privileges": [ "SELECT" ] } ], "user_name": "dlitest" }

请求消息 表2 请求参数 参数 是否必选 参数类型 说明 user_name 否 String 被赋权的用户名称，该用户将有权访问指定的数据库或数据表，被收回或者更新访问权限。 grant_project_id 否 String 被赋权的项目ID，数据赋权给其他项目后，该项目的管理员将有权访问指定的数据库或数据表。 action 是 String 指定赋权或回收。 grant：赋予权限 revoke：回收权限 update：更新权限 说明： 当用户同时拥有grant和revoke权限的时候才有权限使用update操作。 privileges 是 Array of objects 赋权信息。具体参数请参考表3。 表3 privileges参数 参数 是否必选 参数类型 说明 object 是 String 被赋权的数据对象，命名方式为： “databases.数据库名”，则数据库下面的所有数据都将被共享。 “databases.数据库名.tables.表名”, 指定的表的数据将被共享。 “databases.数据库名.tables.表名.columns.列名”，指定的列将被共享。 “edsconnections.连接ID”，赋予某增强型跨源连接的使用权限。 privileges 是 Array of strings 待赋权，回收或更新的权限列表。 说明： 若“action”为“update”，更新列表为空，则表示回收用户在该数据库或表的所有权限。

请求消息 表2 请求参数 参数名称 是否必选 参数类型 说明 plan_name 是 String 队列扩缩容计划名称，名称只能包含数字、英文字母和下划线，但不能是纯数字，且不能以下划线开头。 target_cu 是 Integer 队列扩缩容计划CU的目标值。 start_hour 是 Integer 队列扩缩容计划起始小时时间。 start_minute 是 Integer 队列扩缩容计划的起始分钟时间。 repeat_day 是 Array of strings 定时扩缩容计划的重复周期，可以选择周一到周日的某一天、某几天、或者不选择。如果不选择，则会在当前时间后的start_hour：start_minute时间点执行扩缩容计划。例如： "repeat_day": ["MONDAY", "TUESDAY", "WEDNESDAY","SUNDAY"] valid_date_begin 否 Long 有效期开始时间（13位时间戳）。 valid_date_end 否 Long 有效期结束时间（13位时间戳）。 activate 否 Boolean 当前设置的扩缩容计划是否激活，默认为“true”，表示激活。

URI URI格式： PUT /v1/{project_id}/queues/{queue_name}/plans/{plan_id} 参数说明 表1 URI参数 参数名称 是否必选 参数类型 说明 project_id 是 String 项目编号，用于资源隔离。获取方式请参考获取项目ID。 queue_name 是 String 待修改定时扩缩计划的队列名称。名称长度为1~128个字符，多个队列名称使用逗号“,”分隔。 plan_id 是 String 待修改的队列扩缩容计划的ID。多个ID使用逗号“,”分隔。具体获取请参考查看队列定时扩缩容计划（废弃）

响应消息 表3 响应参数 参数名称 是否必选 参数类型 说明 is_success 否 Boolean 请求执行是否成功。“true”表示请求执行成功。 message 否 String 系统提示信息，执行成功时，信息可能为空。 queue_name 否 String 待修改定时扩缩计划的队列名称。名称长度为1~128个字符，多个队列名称使用逗号“,”分隔。 plan_id 否 Integer 待修改的队列扩缩容计划的ID。多个ID使用逗号“,”分隔。

请求示例 修改名称为plan_A的扩缩容计划，修改后队列在周四和周五的19：30扩扩缩容至64CUs，且暂不激活该扩缩容计划。 { "plan_name": "plan_A", "target_cu": 64, "start_hour": 19, "start_minute": 30, "repeat_day": ["THURSDAY","FRIDAY"], "activate": false }

请求消息 表2 请求参数说明 参数名称 是否必选 参数类型 说明 obs_dir 是 String OBS路径，用于保存导出的作业文件。 is_selected 是 Boolean 是否导出指定的作业。 job_selected 否 Array of Longs 当“is_selected”为“true”时，该参数是待导出作业的ID集合。 说明： 当“is_selected”为“true”时，该参数为必选。

响应示例 [ { "is_success": "true", "message": "作业提交请求下发成功" }, { "is_success": "true", "message": "作业提交请求下发成功" }, { "is_success": "true", "message": "作业提交请求下发成功" }, { "is_success": "true", "message": "作业提交请求下发成功" } ]

请求消息 表2 请求参数说明 参数名称 是否必选 参数类型 说明 job_ids 是 Array of Long 批量作业ID。 作业ID可以通过创建作业接口或者查询作业接口获取。 resume_savepoint 否 Boolean 是否将作业从最近创建的保存点恢复。 当“resume_savepoint”为“true”时，表示作业从最近创建的保存点恢复。 当“resume_savepoint”为“false”时，表示不恢复正常启动。 默认为“false”。

GaussDB(for MySQL)权限 默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 GaussDB(for MySQL)部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问GaussDB(for MySQL)时，需要先切换至授权区域。 根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对GaussDB(for MySQL)服务，管理员能够控制IAM用户仅能对某一类数据库资源进行指定的管理操作。多数细粒度策略以API接口为粒度进行权限拆分，GaussDB(for MySQL)支持的API授权项请参见策略及授权项说明。 如表1所示，包括了云数据库GaussDB(for MySQL)的所有系统权限。 表1 GaussDB(for MySQL)系统权限 策略名称 描述 类别 GaussDB FullAccess 云数据库GaussDB(for MySQL)服务的所有执行权限。 系统策略。 GaussDB ReadOnlyAccess 云数据库GaussDB(for MySQL)服务的只读访问权限。 系统策略。 表2列出了云数据库GaussDB(for MySQL)常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表2 常用操作与系统权限的关系 操作 GaussDB FullAccess GaussDB ReadOnlyAccess 创建GaussDB(for MySQL)实例 支持 不支持 删除GaussDB(for MySQL)实例 支持 不支持 查询GaussDB(for MySQL)实例列表 支持 支持 表3 常用操作与对应授权项 操作名称 授权项 备注 修改参数模板 gaussdb:param:modify - 变更数据库实例的规格 gaussdb:instance:modifySpec - 创建数据库实例 gaussdb:instance:create 界面选择VPC、子网、安全组需要配置： vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get 创建加密实例需要在项目上配置KMS Administrator权限。 创建包周期实例需要配置CBC权限： bss:renewal:view bss:renewal:update bss:balance:view bss:order:view bss:order:update bss:order:pay 创建TDE实例时，需要配置授予创建服务关联委托的权限：iam:agencies:createServiceLinkedAgencyV5。 创建手动备份 gaussdb:backup:create - 查询备份列表 gaussdb:backup:list - 查询错误日志 gaussdb:log:list - 重启实例 gaussdb:instance:restart - 查询数据库实例列表 gaussdb:instance:list - 创建参数模板 gaussdb:param:create - 删除参数模板 gaussdb:param:delete - 修改备份策略 gaussdb:instance:modifyBackupPolicy - 查看参数模板 gaussdb:param:list - 删除实例 gaussdb:instance:delete 退订包周期实例需要配置： bss:unsubscribe:update 删除手动备份 gaussdb:backup:delete - 查询项目标签 gaussdb:tag:list - 应用参数模板 gaussdb:param:apply - 批量添加删除项目标签 gaussdb:instance:dealTag - 变更配额 gaussdb:quota:modify - 升级数据库实例版本 gaussdb:instance:upgrade - 只读升主 gaussdb:instance:switchover - 修改数据库端口 gaussdb:instance:modifyPort - 修改实例安全组 gaussdb:instance:modifySecurityGroup - 修改读写内网地址 gaussdb:instance:modifyIp 界面选择IP需要配置： vpc:vpcs:list vpc:vpcs:get 开启、关闭SSL gaussdb:instance:modifySSL - 修改实例名称 gaussdb:instance:rename - 添加只读节点 gaussdb:instance:addNodes - 删除只读节点 gaussdb:instance:deleteNodes - 修改存储空间 gaussdb:instance:modifyStorageSize - 修改数据库实例密码 gaussdb:instance:modifyPassword - 绑定公网IP gaussdb:instance:bindPublicIp 界面列出公网IP需要配置： vpc:publicIps:get vpc:publicIps:list 解绑公网IP gaussdb:instance:unbindPublicIp - 修改监控策略 gaussdb:instance:modifyMonitorPolicy - 修改节点倒换优先级 gaussdb:instance:modifySwitchoverPriority - 修改可维护时间窗 gaussdb:instance:modifyMaintenanceWindow - 节点隔离 gaussdb:instance:isolateNodes - 修改全量SQL策略 gaussdb:instance:modifyTraceSQLPolicy - 查询HTAP实例列表 gaussdb:htapInstance:list - 创建HTAP实例 gaussdb:htapInstance:create - 修改云数据库 GaussDB HTAP实例 gaussdb:htapInstance:modify - 删除HTAP实例 gaussdb:htapInstance:delete - 修改HTAP实例名称 gaussdb:htapInstance:rename - 重启HTAP实例 gaussdb:htapInstance:restart - 升级HTAP实例版本 gaussdb:htapInstance:upgrade - 倒换HTAP实例 gaussdb:htapInstance:switchover - 变更HTAP实例的规格 gaussdb:htapInstance:modifySpec - 扩容HTAP实例磁盘空间 gaussdb:htapInstance:modifyStorageSize - 绑定HTAP实例公网IP gaussdb:htapInstance:bindPublicIp - 解绑HTAP实例公网IP gaussdb:htapInstance:unbindPublicIp - 修改HTAP实例端口 gaussdb:htapInstance:modifyPort - 修改HTAP实例密码 gaussdb:htapInstance:modifyPassword - 创建HTAP实例数据同步 gaussdb:htapInstance:createDataSync - 修改HTAP实例数据同步 gaussdb:htapInstance:modifyDataSync - 删除HTAP实例数据同步 gaussdb:htapInstance:deleteDataSync - 创建数据库代理 gaussdb:proxy:create - 修改代理地址 gaussdb:proxy:modifyIp - 修改数据库代理读权重 gaussdb:proxy:modifyWeight - 修改数据库代理端口 gaussdb:proxy:modifyPort - 修改数据库代理访问控制 gaussdb:proxy:modifyAccess - 删除数据库代理 gaussdb:proxy:delete - 查询数据库代理列表 gaussdb:proxy:list - 升级数据库代理版本 gaussdb:proxy:upgrade - 修改数据库代理名称 gaussdb:proxy:rename - 扩容数据库代理节点 gaussdb:proxy:addNodes - 缩容数据库代理节点 gaussdb:proxy:deleteNodes - 变更数据库代理规格 gaussdb:proxy:modifySpec - 申请数据库代理内网域名 gaussdb:proxy:createDns - 修改数据库代理域名 gaussdb:proxy:modifyDns - 删除数据库代理域名 gaussdb:proxy:deleteDns - 修改数据库代理路由模式 gaussdb:proxy:modifyRouteMode - 修改数据库代理SSL gaussdb:proxy:modifySSL - 创建数据库用户 gaussdb:user:create - 删除数据库用户 gaussdb:user:delete - 修改数据库用户密码 gaussdb:user:modify - 查询数据库用户 gaussdb:user:list - 数据库用户授权 gaussdb:user:grantPrivilege - 回收数据库用户权限 gaussdb:user:revokePrivilege - 创建数据库 gaussdb:database:create - 删除数据库 gaussdb:database:delete - 查询数据库列表 gaussdb:database:list - 查询预定义标签 - 查询预定义标签需要配置： tms:resourceTags:list 查询配置日志组 - 查询配置日志组需要配置： lts:groups:get 查询配置日志流 - 查询配置日志流需要配置： lts:topics:get 设置自动变配 gaussdb:autoscaling:createPolicy 设置自动变配需要配置： iam:agencies:listAgencies

主实例和只读实例之间可以设置数据同步方式吗 针对MySQL和MariaDB引擎： 只读实例为单个物理节点的架构（没有备节点），采用MySQL和MariaDB的原生复制功能，将主实例的更改同步到所有只读实例，而且主实例和只读实例之间的数据同步不受网络延时的影响。即使数据库没有主键ID，数据也会给只读库同步。 RDS界面上展示的数据同步方式，指的是主实例和备实例之间的数据同步方法，支持半同步（默认）和异步两种。关注数据安全，请选择半同步，关注性能，请选择异步。 对于主实例和只读实例之间，默认是异步方式，不可以修改同步方式。 针对PostgreSQL引擎： 主实例和备实例之间的数据同步方法，支持异步（默认）和同步两种： 对数据库在线时间要求较高的业务，建议选择“异步”模式。 对数据一致性要求极高且能容忍写入操作被阻塞的业务，建议选择“同步”模式。 主实例和只读实例之间支持异步提交模式，且不可以修改。 针对Microsoft SQL Server引擎： 主实例和备实例之间支持同步提交模式，且不可以修改。 主实例和只读实例之间支持异步提交模式，且不可以修改。 更多信息，请参考官方文档。 父主题： 产品咨询

计费说明 表1 计费说明 计费模式 变更操作 对费用的影响 包年/包月 单机转主备 单机转主备后，结合使用周期内的剩余时间，补交差价。 例如：（以下价格仅作示例，实际价格以控制台显示为准） 客户于2023/6/1在华北-北京四购买规格为通用型 2vCPUs 8GB的RDS for MySQL 5.7单机实例，SSD云盘存储，存储空间40GB，购买周期为一个月。此时实例价格为230元/月。 客户在2023/6/15将单机转主备，实例价格为584元/月。 补交费用 = 主备价格 x 剩余周期 - 单机价格 x 剩余周期 公式中的剩余周期为每个自然月的剩余天数/对应自然月的最大天数。 本示例中，剩余周期=15（6月份剩余未使用天数）/ 30（6月份最大天数）= 0.5，代入公式可得补交费用 = 584 x 0.5 - 230 x 0.5 = 177元 按需计费 单机转主备 单机转主备后按小时计费。具体请参见产品价格详情。

云数据库 GeminiDB权限 默认情况下，管理员创建的IAM用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 云数据库 GeminiDB部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问云数据库 GeminiDB时，需要先切换至授权区域。 根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对ECS服务，管理员能够控制IAM用户仅能对某一类云服务器资源进行指定的管理操作。多数细粒度策略以API接口为粒度进行权限拆分，云数据库 GeminiDB支持的API授权项请参见云数据库 GeminiDB服务授权项说明。 如表1所示，包括了云数据库 GeminiDB的所有系统权限。 表1 云数据库 GeminiDB系统权限 策略名称/系统角色 描述 类别 依赖关系 GeminiDB FullAccess 云数据库 GeminiDB服务所有权限。 系统策略 创建包周期实例需要配置CBC权限： bss:balance:view bss:balance:update bss:order:view bss:order:pay bss:order:update bss:renewal:view bss:renewal:update 退订包周期实例需要配置CBC权限： bss:unsubscribe:update GeminiDB ReadOnlyAccess 云数据库 GeminiDB服务只读权限。 系统策略 无 表2列出了云数据库 GeminiDB常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表2 常用操作与系统权限的关系 操作 GeminiDB FullAccess GeminiDB ReadOnlyAccess 创建实例 √ x 查询实例列表 √ √ 查询实例详情 √ √ 查询任务列表 √ √ 删除实例 √ x 重启实例 √ x 重置密码 √ x 变更实例安全组 √ x 修改数据库端口 √ x 绑定/解绑公网IP √ x 磁盘扩容 √ x 规格变更 √ x 节点扩容 √ x 节点缩容 √ x 修改备份策略 √ x 重命名实例 √ x 创建手动备份 √ x 查询备份列表 √ √ 恢复到新实例 √ x 删除备份 √ x 创建参数模板 √ x 查询参数模板列表 √ √ 修改参数模板 √ x 删除参数模板 √ x 查询企业项目配额管理列表 √ √ 修改企业项目配额 √ x 切换SSL开关 √ x 停止备份 √ x 表3列出了云数据库 GeminiDB常用操作以及对应的授权项，您可以参照该表自定义配置权限策略。 表3 常用操作与对应的授权项 操作 授权项 授权范围 备注 实例创建页 vpc:vpcs:list vpc:subnets:get vpc:securityGroups:get 支持： IAM项目(Project) 企业项目(Enterprise Project) 创建页需要查询对应的VPC、子网、安全组。 创建实例 nosql:instance:create vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get 支持： IAM项目(Project) 企业项目(Enterprise Project) 界面使用默认VPC、子网、安全组需对应配置vpc:*:create权限， 创建加密实例需要在项目上配置KMS Administrator权限。 查询实例列表 nosql:instance:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 查询实例详情 nosql:instance:list 支持： IAM项目(Project) 企业项目(Enterprise Project) 如果实例详情界面需要展示VPC、子网、安全组，请增加vpc:*:get和vpc:*:list授权项。 查询任务列表 nosql:task:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 删除实例 nosql:instance:delete 支持： IAM项目(Project) 企业项目(Enterprise Project) 删除实例需要同时删除数据侧IP地址。 重启实例 nosql:instance:restart 支持： IAM项目(Project) 企业项目(Enterprise Project) - 重置密码 nosql:instance:modifyPasswd 支持： IAM项目(Project) 企业项目(Enterprise Project) - 变更实例安全组 nosql:instance:modifySecurityGroup 支持： IAM项目(Project) 企业项目(Enterprise Project) - 修改数据库端口 nosql:instance:modifyPort 支持： IAM项目(Project) 企业项目(Enterprise Project) - 绑定公网IP nosql:instance:bindPublicIp 支持： IAM项目(Project) 绑定公网IP时，需要查询已经创建好的公网IP。 不支持企业项目 不支持细粒度 具体请参见浮动IP。 解绑公网IP nosql:instance:unbindPublicIp 支持： IAM项目(Project) 不支持企业项目 不支持细粒度 具体请参见浮动IP。 磁盘扩容 nosql:instance:modifyStorageSize 支持： IAM项目(Project) 企业项目(Enterprise Project) - 规格变更 nosql:instance:modifySpecification 支持： IAM项目(Project) 企业项目(Enterprise Project) - 节点扩容 nosql:instance:extendNode vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get 支持： IAM项目(Project) 企业项目(Enterprise Project) - 节点缩容 nosql:instance:reduceNode 支持： IAM项目(Project) 企业项目(Enterprise Project) 删除集群节点。 修改备份策略 nosql:instance:modifyBackupPolicy 支持： IAM项目(Project) 企业项目(Enterprise Project) - 重命名实例 nosql:instance:rename 支持： IAM项目(Project) 企业项目(Enterprise Project) - 创建手动备份 nosql:backup:create 支持： IAM项目(Project) 企业项目(Enterprise Project) - 查询备份列表 nosql:backup:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 下载备份文件 nosql:backup:download 支持： IAM项目(Project) 企业项目(Enterprise Project) - 恢复到新实例 nosql:backup:restoreToNewInstance vpc:vpcs:list vpc:vpcs:get vpc:subnets:get vpc:securityGroups:get vpc:ports:get 支持： IAM项目(Project) 企业项目(Enterprise Project) 加密实例需要在项目上配置KMS Administrator权限。 备份恢复到已有实例 nosql:backup:restoreToExistInstance 支持： IAM项目(Project) 企业项目(Enterprise Project) - 删除备份 nosql:backup:delete 支持： IAM项目(Project) 企业项目(Enterprise Project) - 创建参数模板 nosql:param:create 支持： IAM项目(Project) 企业项目(Enterprise Project) - 查询参数模板列表 nosql:param:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 修改参数模板中的参数值 nosql:param:modify 支持： IAM项目(Project) 企业项目(Enterprise Project) - 变更实例下节点的参数配置 nosql:instance:modifyParameter 支持： IAM项目(Project) 企业项目(Enterprise Project) - 删除参数模板 nosql:param:delete 支持： IAM项目(Project) 企业项目(Enterprise Project) - 标签操作 nosql:instance:tag tms:resourceTags:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 标签列表 nosql:tag:list tms:resourceTags:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 查询企业项目配额管理列表 nosql:quota:list 支持： IAM项目(Project) 企业项目(Enterprise Project) - 修改企业项目配额 nosql:quota:modify 支持： IAM项目(Project) 企业项目(Enterprise Project) - 切换审计日志开关 nosql:instance:switchAuditLog 支持： IAM项目(Project) 企业项目(Enterprise Project) - 下载审计日志 nosql:instance:downloadAuditLog 支持： IAM项目(Project) 企业项目(Enterprise Project) - 删除审计日志 nosql:instance:deleteAuditLog 支持： IAM项目(Project) 企业项目(Enterprise Project) - 更新慢日志明文开关 nosql:instance:modifySlowLogPlaintextSwitch 支持： IAM项目(Project) 企业项目(Enterprise Project) - 切换SSL开关 nosql:instance:switchSSL 支持： IAM项目(Project) 企业项目(Enterprise Project) - 修改内网IP nosql:instance:modifyPrivateIp 支持： IAM项目(Project) 企业项目(Enterprise Project) - 切换主备节点 nosql:instance:switchover 支持： IAM项目(Project) 企业项目(Enterprise Project) - 数据库补丁升级 nosql:instance:upgradeDatabaseVersion 支持： IAM项目(Project) 企业项目(Enterprise Project) - 停止备份 nosql:backup:stop 支持： IAM项目(Project) 企业项目(Enterprise Project) - 查询日志配置组 lts:groups:get 支持： IAM项目(Project) 企业项目(Enterprise Project) - 查询日志配置流 lts:topics:get 支持： IAM项目(Project) 企业项目(Enterprise Project) -

响应示例 状态码： 200 正常返回。 { "failure_list" : [ { "resource" : "982b8a6a6ebc43809d82a46ca99aaeb7", "failure_info" : "ELB.8904:certificate 982b8a6a6ebc43809d82a46ca99aaeb7 does not exist" } ] } 状态码： 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 500 请求未完成，服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 failure_list Array of FaiureResource objects 部署失败的资源列表。 数组长度：1 - 20 表6 FaiureResource 参数 参数类型 描述 resource String 部署失败的资源信息,部署WAF与ELB时，此字段为资源ID，部署CDN时，本字段为加速域名。 最小长度：0 最大长度：63 failure_info String 失败原因，一般为目标服务返回的错误码信息。 最小长度：0 最大长度：255 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：32 最大长度：2097152 表3 请求Body参数 参数 是否必选 参数类型 描述 project_name 否 String 部署的资源所在的项目名称，若在主项目下，则该值为region id。 最小长度：1 最大长度：255 service_name 是 String 证书推送的目标服务，当前仅支持：CDN、WAF、ELB。 最小长度：1 最大长度：64 resources 是 Array of DeployedResource objects 所要部署的资源列表。 数组长度：1 - 20 表4 DeployedResource 参数 是否必选 参数类型 描述 id 否 String 资源Id,部署WAF与ELB时，必传此字段。 最小长度：0 最大长度：63 type 否 String 资源类型，当前仅部署WAF资源时需传入，即独享模式（premium）与云模式（cloud）。 最小长度：0 最大长度：63 domain_name 否 String 需部署的域名，当前仅部署CDN时需传入，即需加速的域名，域名与证书必须可匹配。 最小长度：0 最大长度：63 enterprise_project_id 否 String 需部署的资源所属的企业项目ID，当前仅部署WAF资源时，需传入。 最小长度：0 最大长度：63

响应示例 状态码： 200 正常返回。 { "id" : "scs1590053258704", "order_id" : "CS20052117270N7V9", "name" : "scm-testing", "type" : "DV_SSL_CERT", "brand" : "SYMANTEC", "push_support" : "OFF", "revoke_reason" : null, "status" : "CHECKING_DOMAIN", "signature_algorithm" : null, "issue_time" : null, "not_before" : null, "not_after" : null, "validity_period" : 12, "validation_method" : "DNS", "domain_type" : "SINGLE_DOMAIN", "multi_domain_type" : null, "domain" : "hosting-******.test.cn", "sans" : null, "domain_count" : 1, "wildcard_count" : 0, "fingerprint" : "185d687de3f44f2249d0e0f084efccb56b7c2cbe", "enterprise_project_id" : "0", "authentification" : [ { "record_name" : "_dnsauth.hosting-****.test.cn", "record_type" : "TXT", "record_value" : "201801040000001ytm4q************cd8p7eg9ktlwfsord", "domain" : "hosting-*****.test.cn" } ] } 状态码： 401 认证失败。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 403 禁止访问。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" } 状态码： 500 请求未完成，服务器内部异常。 { "error_code" : "SCM.XXX", "error_msg" : "XXX" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 证书id。 最小长度：16 最大长度：16 status String 证书状态。取值如下： PAID：证书已支付，待申请证书。 ISSUED：证书已签发。 CHECKING：证书申请审核中。 CANCELCHECKING：取消证书申请审核中。 UNPASSED：证书申请未通过。 EXPIRED：证书已过期。 REVOKING：证书吊销申请审核中。 REVOKED：证书已吊销。 UPLOAD：证书托管中。 SUPPLEMENTCHECKING：多域名证书新增附加域名审核中。 CANCELSUPPLEMENTING：取消新增附加域名审核中。 最小长度：0 最大长度：32 order_id String 订单id。 最小长度：0 最大长度：63 name String 证书名称。 最小长度：3 最大长度：63 type String 证书类型。取值如下： DV_SSL_CERT、DV_SSL_CERT_BASIC、EV_SSL_CERT、 EV_SSL_CERT_PRO、OV_SSL_CERT、OV_SSL_CERT_PRO。 最小长度：0 最大长度：32 brand String 证书品牌。取值如下： GLOBALSIGN、SYMANTEC、GEOTRUST、CFCA。 最小长度：0 最大长度：32 push_support String 证书是否支持推送。 最小长度：0 最大长度：32 revoke_reason String 证书吊销原因。 最小长度：0 最大长度：255 signature_algorithm String 签名算法。 最小长度：0 最大长度：64 issue_time String 证书签发时间，没有获取到有效值时为空。 最小长度：0 最大长度：32 not_before String 证书生效时间，没有获取到有效值时为空。 最小长度：0 最大长度：32 not_after String 证书失效时间，没有获取到有效值时为空。 最小长度：0 最大长度：32 validity_period Integer 证书有效期，按月为单位。云证书管理服务提供了一种购买多年有效期证书的解决方案，这种多年有效期证书生效方式为多张有效期为1年的SSL证书叠加生效，例如：有效期为“3年”的证书实际包含3张有效期为1年且规格相同的SSL证书，在第一张证书到期前30天，系统自动以第一张证书的信息申请第二张证书，在第二张证书到期前30天，系统自动以第一张证书的信息申请第三张证书。 最小值：12 最大值：12 validation_method String 域名认证方式，取值如下：DNS、FILE、EMAIL。 最小长度：0 最大长度：32 domain_type String 域名类型，取值如下： SINGLE_DOMAIN：单域名 WILDCARD：通配符 MULTI_DOMAIN：多域名 最小长度：0 最大长度：32 multi_domain_type String 多域名类型，取值如下： primary_single 主单 primary_wildcard 主泛 最小长度：0 最大长度：32 domain String 证书绑定域名。 最小长度：0 最大长度：255 sans String 证书绑定的附加域名信息。 最小长度：0 最大长度：4096 domain_count Integer 证书可绑定域名个数。 最小值：1 最大值：100 wildcard_count Integer 证书可绑定附加域名个数。 最小值：0 最大值：99 fingerprint String 证书的SHA-1指纹。 最小长度：40 最大长度：40 enterprise_project_id String 企业项目ID，默认为“0”。 对于开通企业项目的用户，表示资源处于默认企业项目下。 对于未开通企业项目的用户，表示资源未处于企业项目下。 最小长度：0 最大长度：36 authentification Array of Authentification objects 域名所有权认证信息，详情请参见Authentification字段数据结构说明。 数组长度：0 - 100 表4 Authentification 参数 参数类型 描述 record_name String 域名校验值名字。 最小长度：0 最大长度：255 record_type String 域名校验值类型。 最小长度：0 最大长度：255 record_value String 域名校验值。 最小长度：0 最大长度：255 domain String 校验值对应的域名。 最小长度：0 最大长度：255 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误请求返回的错误码。 最小长度：3 最大长度：36 error_msg String 错误请求返回的错误信息。 最小长度：0 最大长度：1024

URI GET /v1/{project_id}/authorization/cooperate-authorization/properties 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID。 resource_type 是 String 资源类型。 支持的资源类型：Datasource，Dataset，Dashboard，Screen，Subject。

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Workspace-Id 是 String 工作空间ID，即控制台的项目ID。 可以通过查询工作空间获取工作空间ID。 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见Token认证。

响应示例 { "create_date" : 1682576908274, "create_user" : "aoeusth", "create_user_name" : "xxxx", "update_date" : 1683343425273, "update_user" : "aeousth", "update_user_name" : "xxxx", "id" : "xxxxx1f0-dea2-472c-aa9c-25928f74xxxx", "resource_type" : "dataset", "resource_id" : "xxxx406b-8662-4adb-a028-a55cxxxx1166", "auth_switch_config" : { "edit" : false, "read" : true }, "owner" : "xxxxx4a863a94b0ba2887b80dcxxxx3", "project_id" : "9c3043axxxac4055888643b331a0bxxx", "workspace_id" : "66a2c96809ad4f62ba09e6b6eeaa2146" }

响应示例 状态码： 200 OK。 { "auth_switch_config" : "{"read": true, "edit": true, "export": true}", "create_date" : 1688022840899, "create_user" : "de9cb4xxxxa94b0ba2887b80xxxxxxxx", "create_user_name" : "***_01", "id" : "78215911-xxxx-478b-xxxx-9cb7f0407598", "owner" : "dxxxxa863a94xxxa2887b80xxxxxxxx", "project_id" : "xxx3ab4dac40558886xxxxx1a0b227", "resource_id" : "d0xxx19c-4e87-46xx-bxx2-da82bfxxxx4e", "resource_type" : "dashboard", "update_date" : 1688023886860, "update_user" : "de9cb4a863a94b0ba2887b80xxxxxxxx", "update_user_name" : "ei_dlv_***_01", "workspace_id" : "6xxxx96809adxxxxxa09e6bxxxx2146" }

请求示例 保存或修改资源分享协作属性值。 POST https://{endpoint}/v1/xxxxx3ab4dac4055888643b331xxxxx/authorization/cooperate-authorization/properties { "auth_switch_config" : "{"read": true, "edit": true, "export": true}", "resource_id" : "d0d7919c-xxxx-462e-xxxx-da82bf8be44e", "resource_type" : "dashboard" }

请求方法 HTTP请求方法（也称为操作或动词），可告知服务正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求消息头 附加请求消息头字段，如指定的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。 POST/PUT请求必填。 GET不能包含。 3495 X-Project-ID project id，项目编号。在多项目场景中使用，用于不同项目获取token。 否 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 IAM用户Token也就是调用“获取用户Token”接口的响应值，该接口是唯一不需要认证的接口。 使用Token方式认证时必选 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ Authorization 签名认证信息。该值来源于请求签名结果。 使用AK/SK认证时必选。 - X-Sdk-Date 请求的发生时间，格式为(YYYYMMDD'T'HHMMSS'Z')。 取值为当前系统的GMT时间。 使用AK/SK认证时必选。 20150907T101459Z X-Language 请求语言。 否 en-us API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 例如，对于IAM获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 例如，对于IAM获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，例如cn-north-1，可以从地区和终端节点中获取。 scope参数定义了Token的作用域，下面示例中IAM获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见IAM获取用户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": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于IAM获取用户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-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也是相同，所以简洁起见将这两部分省略。