GaussDB授权分类
表1 实例管理
API功能
授权项
授权范围
对应API接口
创建数据库实例
gaussdb:instance:create
gaussdb:param:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances
扩容数据库实例的磁盘空间
gaussdb:instance:modifySpec
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/action
删除数据库实例
gaussdb:instance:delete
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
DELETE /v3/{project_id}/instances/{instance_id}
查询数据库实例列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances
重置数据库密码
gaussdb:instance:modifyPasswd
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/password
修改实例名称
gaussdb:instance:rename
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/instances/{instance_id}/name
重启数据库实例
gaussdb:instance:restart
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/restart
分片节点主备切换
gaussdb:instance:switchShard
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/switch-shard
查询实例的组件列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/components
规格变更
gaussdb:instance:modifySpec
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/instance/{instance_id}/flavor
查询实例主备平衡状态
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/balance
查询解决方案模板配置
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/deployment-form
查询已绑定的EIP列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/public-ips?offset={offset}&limit={limit}
弱密码校验
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/weak-password-verification
绑定/解绑弹性公网IP
gaussdb:instance:bindPublicIp
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/nodes/{node_id}/public-ip
查询实例SSL证书下载地址
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/ssl-cert/download-link
查询租户的实例配额
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/project-quotas?type={type}
表2 参数配置
API功能
授权项
授权范围
对应API接口
获取参数模板列表
gaussdb:param:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/configurations?offset={offset}&limit={limit}
获取指定实例的参数
gaussdb:param:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/configurations
修改指定实例的参数
gaussdb:param:modify
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/instances/{instance_id}/configurations
创建参数模板
gaussdb:param:create
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/configurations
删除参数模板
gaussdb:param:delete
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
DELETE /v3/{project_id}/configurations/{config_id}
查询参数模板详情
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/configurations/{config_id}
复制参数模板
gaussdb:param:create
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/configurations/{config_id}/copy
重置参数组
gaussdb:param:modify
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/configurations/{config_id}/reset
比较两个参数组模板之间的差异
gaussdb:param:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/configurations/comparison
查询可应用实例列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/configurations/{config_id}/applicable-instances
校验参数组名称是否存在
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/configurations/name-validation?name={name}
应用参数模板
gaussdb:param:apply
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/configurations/{config_id}/apply
查询参数模板的应用记录
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/configurations/{config_id}/applied-histories
查询参数模板的修改历史
gaussdb:param:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/configurations/{config_id}/histories
表3 备份管理
API功能
授权项
授权范围
对应API接口
设置自动备份策略
gaussdb:instance:modifyBackupPolicy
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/instances/{instance_id}/backups/policy
查询自动备份策略
gaussdb:backup:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/backups/policy
查询备份列表
gaussdb:backup:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/backups?instance_id={instance_id}&backup_id={backup_id}&backup_type={backup_type}&offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}
创建手动备份
gaussdb:backup:create
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/backups
删除手动备份
gaussdb:backup:delete
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
DELETE /v3/{project_id}/backups/{backup_id}
查询可恢复时间段
gaussdb:backup:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/restore-time?date={date}
恢复到新实例
gaussdb:instance:create
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances
查询可用于备份恢复的实例列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/restorable-instances
根据时间点或者备份文件查询原实例信息
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instance-snapshot?instance_id={instance_id}&backup_id={backup_id}&restore_time={restore_time}
表4 引擎版本和规格
API功能
授权项
授权范围
对应API接口
查询数据库引擎的版本
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/datastore/versions
查询数据库规格
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/flavors?limit={limit}&offset={offset}&ha_mode={ha_mode}&version={version}&spec_code={spec_code}
查询引擎列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/datastores
查询实例可变更规格
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/available-flavors
表5 管理数据库和用户
API功能
授权项
授权范围
对应API接口
创建数据库
gaussdb:instance:createDatabase
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/database
创建数据库用户
gaussdb:instance:createDatabaseUser
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/db-user
创建数据库SCHEMA
gaussdb:instance:createDatabaseSchema
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/schema
授权数据库账号
gaussdb:instance:grantDatabasePrivilege
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/db-privilege
重置数据库账号密码
gaussdb:instance:modifyDatabasePasswd
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/instances/{instance_id}/db-user/password
查询数据库列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/databases
查询数据库用户列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/db-users
查询数据库SCHEMA列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/schemas
表6 标签管理
API功能
授权项
授权范围
对应API接口
查询实例标签
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/tags
查询项目标签
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/tags
查询预定义标签
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/predefined-tags
添加实例标签
gaussdb:instance:dealTag
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
POST /v3/{project_id}/instances/{instance_id}/tags
表7 磁盘管理
API功能
授权项
授权范围
对应API接口
查询实例存储空间使用信息
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/instances/{instance_id}/volume-usage
查询数据库磁盘类型
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/storage-type?version={version}&ha_mode={ha_mode}
表8 配额管理
API功能
授权项
授权范围
对应API接口
修改企业项目配额
gaussdb:quota:modify
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/enterprise-projects/quotas
查询企业项目配额组
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/enterprise-projects/quotas
表9 任务管理
API功能
授权项
授权范围
对应API接口
获取任务信息
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/jobs?id={id}
查询任务列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/tasks
删除任务记录
gaussdb:instance:deleteTaskRecord
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
DELETE /v3/{project_id}/jobs/{job_id}
表10 回收站
API功能
授权项
授权范围
对应API接口
设置回收站策略
gaussdb:instance:setRecyclePolicy
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
PUT /v3/{project_id}/recycle-policy
查看回收站策略
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/recycle-policy
查询回收站所有引擎实例列表
gaussdb:instance:list
- 支持：
IAM项目(Project)
- 支持：
企业项目(Enterprise Project)
GET /v3/{project_id}/recycle-instances
