华为云用户手册

  • URI URI格式 PUT https://{Endpoint}/v3/{project_id}/recycle-policy URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。
  • 响应消息 正常响应要素说明 表2 要素说明 名称 参数类型 说明 datastores Array of objects 数据库引擎列表。 详情请参见表3。 表3 dataStores字段数据结构说明 参数 参数类型 描述 supported_versions Array of strings 部署形态支持的引擎版本列表。 instance_mode String 部署形态。 枚举值: ha:主备版 independent:独立部署 正常响应样例 { "datastores": [ { "instance_mode": "ha", "supported_versions": [ "2.0", "2.3", "2.6", "2.9" ] } ] }
  • URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/password URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01/password 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。
  • URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in01 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。
  • 响应消息示例 正常响应要素说明 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "2.0", "datastore_name": " GaussDB ", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "Determines whether to audit the CREATE, DROP, and ALTER operations on GaussDB Kernel database objects. GaussDB Kernel database objects include databases, users, schemas, and tables. You can change the parameter value to audit only the operations on required database objects. During a forcible primary/standby failover, set audit_system_object to the maximum value and audit all DDL objects. If the parameter value is incorrectly changed, DDL audit logs will be lost. Contact customer service personnel to change it.", "restart_required": false, "value_range": "0-2097151" } ] }
  • 支持的授权项 策略包含系统策略和自定义策略,如果系统策略不满足授权要求,管理员可以创建自定义策略,并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM 项目(Project)/企业项目(Enterprise Project):自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 “√”表示支持,“x”表示暂不支持。
  • URI URI格式 POST https://{Endpoint}/v3/{project_id}/configurations/{config_id}/reset URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14/reset 参数说明 表1 参数说明 名称 参数类型 是否必选 说明 project_id String 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 config_id String 是 参数模板ID。
  • 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需要project级别的Token,即调用获取用户Token接口时,请求body中auth.scope的取值需要选择project,如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } }
  • URI URI格式 POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/restart URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/restart 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 String 实例ID。
  • 请求示例 修改企业项目配额,实例的配额设置为1000个,cpu配额100000核数,内存配额200000GB,存储空间配额1000000GB。 { "eps_quotas": [ { "enterprise_projects_id": "0", "instance_quota": 1000, "vcpus_quota": 100000, "ram_quota": 200000, "volume_quota": 1000000 } ] }
  • URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/ssl-cert/download-link URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/dsfae23fsfdsae3435in14/ssl-cert/download-link 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 String 实例ID。
  • 响应消息 正常响应要素说明 表4 参数说明 参数 参数类型 描述 id String 参数模板ID。 name String 参数模板名称。 created_at String 创建时间,格式为“yyyy-mm-ddThh:mm:ssZ”。 其中,T指某个时间的开始;Z指时区偏移量,例如北京时间偏移显示为+0800。 正常响应样例 { "id" : "137eeaf0cc884ca4adffa9ebd101c115pr14", "name" : "paramTemplate-del", "created_at" : "2022-08-09T03:06:52+0800" }
  • 请求示例 创建一个2.3版本,主备版部署形态的参数模板。 { "name": "paramTemplate", "description": "", "parameter_values": { "audit_system_object": "12294" }, "datastore": { "engine_version": "2.3", "instance_mode": "ha" } }
  • URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/configurations/{config_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/configurations/3ca44134a16d4bbab8eb701e025b19f7pr14 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 config_id 是 String 参数模板ID。
  • URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/volume-usage URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/volume-usage 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。
  • URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/backups/e28d08754b1a490fb2b3540ed013a7fbbr14 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 backup_id 是 String 备份ID。
  • 请求示例 修改实例的参数failed_login_attempts的值为4。不需要重启。 { "values": { "failed_login_attempts": "4" } } 修改实例的参数track_activity_query_size的值为2048,修改参数max_replication_slots的值为25。需要重启。 { "values": { "track_activity_query_size": "2048", "max_replication_slots": "30" } }
  • URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/balance URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instance/dsfae23fsfdsae3435in14/balance 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。
  • URI URI格式 POST https://{Endpoint}/v3/{project_id}/weak-password-verification URI样例 https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/weak-password-verification 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。
  • 响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 quotas object 租户实例配额信息。 详情请参见表3。 表3 project-quotas 参数 参数类型 描述 resources Array of objects 资源列表对象。 详情请参见表4。 表4 resources 参数 参数类型 描述 type String 指定类型的配额。 instance: 表示实例的配额。 used Integer 已创建的资源个数。 quota Integer 资源最大的配额数。
  • 请求示例 切换多个DN分片的主备。 { "shards": [ { "node_id": "0bc478b4d132494a8f7b804da521b4b2no14", "component_id": "dn_6001" }, { "node_id": "53dee94c50574d36a0060db0a6b644f6no14", "component_id": "dn_6004" } ] }
  • 响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 tags Array of objects 用户标签列表。 详情请参见表3。 total_count Integer 总记录数。 表3 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符,key不能为空。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value Array of strings 标签值。最大长度43个unicode字符,可以为空字符串。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。 正常响应样例 标签列表: { "tags" : [ { "key" : "key1", "value" : [ "value1", "value2" ] }, { "key" : "key2", "value" : [ "value2", "value3" ] } ], "total_count": 2 }
  • URI URI格式 GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/tags URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/instances/dsfae23fsfdsae3435in14/tags 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 instance_id 是 实例ID。
  • 响应消息体(可选) 该部分可选。响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体,为篇幅起见,这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时,会返回错误码及错误信息说明,错误响应的Body体格式如下所示。 { "error_code": "AS.0001", "error_msg": "The format of message is error" } 其中,“error_code”表示错误码,“error_msg”表示错误描述信息。
  • 请求示例 设置GaussDB实例备份策略,备份文件保存时长7天,备份时间段为"19:00-20:00"。 { "backup_policy": { "keep_days": 7, "start_time": "19:00-20:00", "period": "1,2,3,4,5", "differential_period": "30", "rate_limit": 75 , "prefetch_block": 64 , "file_split_size": 4 , "enable_standby_backup" : "false" } }
  • URI URI格式 DELETE https://{Endpoint}/v3/{project_id}/jobs/{job_id} URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0483b6b16e954cb88930a360d2c4e663/jobs/6b00c41d-d54f-4bcb-80da-566ccedc2b5d 参数说明 表1 参数说明 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。 job_id 是 String 任务id。
  • URI URI格式 GET https://{Endpoint}/v3/{project_id}/recycle-policy URI样例 https://gaussdb-opengauss.cn-north-1.myhuaweicloud.com/v3/0611f1bd8b00d5d32f17c017f15b599f/recycle-policy 参数说明 表1 参数说明 名称 是否必选 说明 project_id 是 租户在某一region下的project ID。 获取方法请参见获取项目ID/名称。
  • 响应消息 正常响应要素说明 表2 参数说明 参数 参数类型 描述 tags Array of objects 标签列表。 详情请参见表3。 表3 tags字段数据结构说明 参数 参数类型 描述 key String 标签键。最大长度36个unicode字符,key不能为空。 字符集:0-9,A-Z,a-z,“_”,“-”,中文。 value Array of strings 标签值。最大长度43个unicode字符,可以为空字符串。 字符集:0-9,A-Z,a-z,“_”,“.”,“-”,中文。 正常响应样例 标签列表: { "tags" : [ { "key" : "key1", "value" : [ "value1", "value2" ] }, { "key" : "key2", "value" : [ "value2", "value3" ] } ] } 异常响应 请参见异常请求结果。
  • 响应消息示例 正常响应要素说明 { "created": "2022-04-11 10:46:59", "updated": "2022-04-11 10:46:59", "datastore_version": "2.0", "datastore_name": "GaussDB(for openGauss)", "configuration_parameters": [ { "name": "audit_system_object", "value": "12295", "type": "integer", "description": "该参数决定是否对数据库对象的CREATE、DROP、ALTER操作进行审计。", "restart_required": false, "value_range": "0-2097151" } ] }
共100000条