华为云用户手册

URI GET https://{Endpoint}/v3/{project_id}/backups 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表2 Query参数 参数 是否必选 参数类型 描述 offset 是 Integer 参数解释： 分页页码。 约束限制： 不涉及。 取值范围： 取值大于等于1。 默认取值： 不涉及。 limit 是 Integer 参数解释： 每页条数。 约束限制： 不涉及。 取值范围： 1-100。 默认取值： 不涉及。 datastore_type 否 String 参数解释： 接口类型。 取值范围： 取值为“cassandra”，表示查询GeminiDB Cassandra引擎。 取值为“mongodb”，表示GeminiDB Mongo查询引擎。 取值为“redis”，表示查询GeminiDB Redis引擎。 取值为“influxdb”，表示查询GeminiDB Influx引擎。 默认取值： 不传该参数时则查询所有的接口。 type 否 String 参数解释： 备份策略类型。 取值范围： Instance，表示查询实例级备份。 DatabaseTable，表示查询库表级备份，仅GeminiDB Cassandra支持。 默认取值： “Instance”。 instance_id 否 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不传该参数则查询所有备份列表。 backup_id 否 String 参数解释： 备份ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不传该参数则查询所有备份列表。 backup_type 否 String 参数解释： 备份类型。 约束限制： 不涉及。 取值范围： Auto：自动全量备份 Manual：手动全量备份。 Incremental：增量备份。 Differential：差异备份。 默认取值： 不涉及。 begin_time 否 String 参数解释： 查询备份开始的时间。 约束限制： 该时间为UTC时间。 取值范围： 格式为“yyyy-mm-dd hh:mm:ss”。 默认取值： 不涉及。 end_time 否 String 参数解释： 查询备份开始的结束时间。 约束限制： 该时间为UTC时间。 取值范围： 格式为“yyyy-mm-dd hh:mm:ss”。 默认取值： 不涉及。

状态码 正常 状态码 编码 状态说明 200 OK 请求成功。 204 No Content 请求成功，无响应内容。 202 Accepted 异步请求成功提交。 异常 状态码 编码 状态说明 400 Bad Request 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法，请确认用户名和密码是否正确。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 422 Unprocessable Entity 请求格式正确，但是由于含有语义错误，无法响应。 500 Internal Server Error 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为 IAM 的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 表1 错误码说明 HTTP状态码 错误码 错误信息 描述 处理措施 400 DBS.200001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 404 DBS.200002 The DB instance does not exist. 实例不存在或已被删除。 检查实例ID、实例是否正确，实例是否存在。 400 DBS.200010 Authentication failed. 鉴权失败。 检查租户与实例的关系是否匹配。 403 DBS.200011 This instance {0} status makes it not be allowed to do this {1} operation now. 实例状态不允许。 检查实例的状态或实例正在进行的操作是否与请求冲突。 404 DBS.200013 This node does not exist. 节点不存在。 检查节点ID或组ID是否正确。 403 DBS.200018 This instance's status or its node's status makes it not be allowed to do this operation now. 实例不可用。 检查实例的状态或实例正在进行的操作是否与请求冲突。 403 DBS.200019 Another operation is being performed on the DB instance or the DB instance is faulty. 实例状态不允许。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200022 The DB instance name {0} already exists. 该实例名已存在。 检查实例名称是否已经存在。 400 DBS.200024 The region is unavailable. 所选区域不可用。 检查区 域名 称是否正确，区域是否在可用范围内。 400 DBS.200025 Invalid AZ. 可用区非法。 检查可用区名称是否正确，可用区是否在可用范围内。 403 DBS.200028 Volume size reach limit. 磁盘大小已达到最大限制。 检查设置的磁盘大小是否已经超过上限。 400 DBS.200029 Invalid username and password. 非法的用户名密码。 检查用户名和密码是否匹配，密码是否符合密码要求。 400 DBS.200041 Invalid datastore version. 数据库版本非法。 检查数据库的版本号是否支持。 404 DBS.200042 Invalid database engine. 数据库接口非法。 检查数据库接口是否为云数据库 GeminiDB支持的接口。 400 DBS.200047 Operation cannot be executed in current state of the DB instance or node. 不合法的实例或节点状态，该操作不允许。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200048 Invalid VPC. 非法的虚拟私有云。 检查VPC ID、名称是否正确，是否符合要求。 400 DBS.200049 Invalid subnet. 非法的子网。 检查子网ID、名称是否正确，是否符合要求。 400 DBS.200050 Invalid security group. 非法的安全组。 检查安全组ID、名称是否正确，是否符合要求。 400 DBS.200052 Invalid password. 非法密码。 检查用户名和密码是否匹配，密码是否符合密码要求。 400 DBS.200053 The DB instance specifications do not exist. 实例规格不存在。 检查规格是否正确，当前可用区是否支持该规格。 400 DBS.200054 Invalid DB instance specifications. 下发规格非法。 检查规格是否正确，当前可用区是否支持该规格。 400 DBS.200057 Invalid parameter group ID. 非法的参数模板。 检查参数模板是否为云数据库 GeminiDB接口支持的参数模板。 404 DBS.200058 Parameter template does not exist. 参数模板不存在。 检查参数模板是否存在。 400 DBS.200059 Invalid database port. 非法的数据库端口。 检查数据库端口是否缺失或者数据库端口是否合法。 400 DBS.200060 The database port number is out of the specified range. 数据库端口不在指定范围内。 检查数据库端口是否合法。 400 DBS.200063 Invalid DB instance type. 非法的实例类型。 检查实例类型是否合法。 400 DBS.200068 Weak password. 弱密码。 检查密码是否过于简单，请更改为较复杂的密码。 400 DBS.200072 Invalid storage space. 磁盘大小超限。 检查磁盘大小是否超出了最大限制。 400 DBS.200075 Invalid node role. 非法的节点角色。 检查节点角色是否符合要求，实例是否正常。 403 DBS.200076 Operation cannot be executed in current state of the DB instance. 实例状态不允许。 检查实例的状态或实例正在进行的操作是否与请求冲突。 400 DBS.200077 Failed to change the password. 更新密码失败。 检查用户名是否正确。 400 DBS.200091 Invalid IP address. 无效的IP。 检查是否缺少必要的IP地址或者传入的IP地址是否合法。 400 DBS.200092 The IP address already exists. IP已经存在。 检查IP是否已经存在。 400 DBS.200095 Invalid parameter. 参数错误。 检查请求体和URL的参数是否正确。 500 DBS.200165 Insufficient enterprise project instance quota range. 企业项目实例配额不足。 在GeminiDB控制台修改配额。 500 DBS.200166 Insufficient enterprise project cpu quota range. 企业项目CPU配额不足。 在GeminiDB控制台修改配额。 500 DBS.200167 Insufficient enterprise project mem quota range. 企业项目内存配额不足。 在GeminiDB控制台修改配额。 400 DBS.200302 The storage space increase must be a positive integer. 扩容磁盘大小不是正整数。 检查磁盘大小是否是正整数。 400 DBS.200303 The maximum number of times that the storage space can be scaled up has been reached. 扩容磁盘次数已达上限。 实例的扩容磁盘次数已达上限，需要继续扩容请联系技术支持。 400 DBS.200304 The storage space can be scaled up for a maximum of four times. 最多存储扩容四次。 检查实例是否已经进行了多次扩容。 400 DBS.200306 Invalid storage space. 非法的磁盘大小。 检查磁盘大小的值是否正确，是否符合要求。 400 DBS.200311 Scaling up storage space is not allowed in current state of the node. 节点不允许磁盘扩容。 检查节点类型是否正确，实例类型是否正确，节点ID是否正确。 400 DBS.200434 Failed to restart the DB instance. 重启实例失败。 检查实例状态是否正常，实例否正在进行其它操作。 400 DBS.200451 The node does not exist. 节点不存在。 检查节点ID是否有误。 400 DBS.200462 The database port is the same as the current port. 数据库端口和当前端口相同。 检查修改端口号时是否下发了相同的端口。 400 DBS.200470 Invalid AZ. 非法的可用区。 检查可用区是否正确。 400 DBS.200501 The subnet does not exist. 该子网已经被删除。 检查子网ID、名称是否存在，是否匹配VPC。 400 DBS.200502 The security group does not exist. 安全组不存在，或不属于该vpc。 检查安全组ID、名称是否存在，是否匹配VPC。 400 DBS.200503 The VPC does not exist. 该vpc已经被删除。 检查租户是否拥有该VPC。 400 DBS.200506 The encryption key does not exist. 磁盘加密密钥ID不存在。 检查磁盘加密密钥ID是否存在。 400 DBS.200507 The encryption key is not available. 磁盘加密密钥状态不可用。 检查磁盘加密密钥状态是否是可用状态。 400 DBS.200604 The instance is not owned by the current user. 实例不属于当前用户。 检查project_id和实例ID是否具有从属关系。 400 DBS.200700 The EIP status does not allow EIP binding. EIP正在绑定中，不允许再次下发绑定。 检查实例是否正在绑定弹性公网IP。 400 DBS.200701 The EIP status does not allow EIP unbinding. EIP状态不允许解绑。 检查弹性公网IP的状态是否允许该操作。 400 DBS.200702 The node has been bound to a public IP address and cannot be bound again. 该节点已经绑定过弹性公网IP，不能再次下发绑定。 检查节点是否已经有绑定的弹性公网IP。 400 DBS.200705 The PublicIp does not exist. 要绑定的弹性公网IP不存在。 检查弹性公网IP和ID是否关联，是否存在。 400 DBS.200816 Failed to create the database user. 创建数据库用户失败。 检查数据库用户名称是否合法，并且检查数据库状态以及实例状态。 400 DBS.200817 Failed to obtain the database user list. 获取数据库用户列表失败。 检查数据库状态以及实例状态。 400 DBS.200818 Failed to delete the database user. 删除数据库用户失败。 检查数据库状态以及实例状态。 400 DBS.200823 The database does not exist. 数据库不存在。 检查数据库名称是否合法。 400 DBS.200824 The database account does not exist. 数据库账号不存在。 检查数据库用户名称是否合法。 400 DBS.200826 The database name already exists. 数据库名称已存在。 检查数据库名称是否合法。 400 DBS.200827 The database user already exists. 数据库账号名称已存在。 检查数据库用户是否合法。 400 DBS.200828 Built-in database accounts cannot be edited. 数据库内置账号，用户不可操作。 检查数据库用户是否合法。 500 DBS.200998 The system is busy. Try again later. 系统繁忙，请稍后再试。 系统繁忙， 稍后再试。 403 DBS.201000 The status of DB instance {0} does not allow the {1} operation. 实例状态不允许。 检查实例状态或实例正在进行的操作是否和请求冲突。 400 DBS.201006 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确。 403 DBS.201014 Operation cannot be executed in current state of the DB instance. 实例状态不允许操作。 检查实例状态或实例正在进行的操作是否和请求冲突。 403 DBS.201015 This operation cannot be performed because another operation is being performed on the DB instance or the DB instance is faulty. Try again later. 该实例正在进行其它操作或该实例故障，无法执行该操作，请稍后重试。 检查实例状态或实例正在进行的操作是否和请求冲突。 400 DBS.201020 Invalid DB engine. 数据库接口非法。 检查数据库接口是否为云数据库 GeminiDB服务支持的接口。 403 DBS.201028 The DB instance does not exist. 实例不存在或已被删除。 检查实例是否属于该租户，实例是否存在。 400 DBS.201035 The database name must be different. 存在相同的数据库名称。 检查是否存在相同的数据库名称。 400 DBS.201038 The collection name must be different. 存在相同的集合名称。 检查是否存在相同的集合名称。 400 DBS.201101 Invalid backup period. 备份周期非法。 检查备份周期是否符合要求。 400 DBS.201106 Invalid retention period. 保留天数非法。 检查备份保留天数是否正确。 400 DBS.201201 The backup already exists. 备份已存在。 检查该备份的备份名称或ID是否已经存在。 400 DBS.201202 Operation cannot be executed in current state of the DB instance. 实例不允许操作。 检查实例状态或实例正在进行的操作是否和请求冲突。 400 DBS.201204 Operation cannot be executed in current state of the DB instance. 备份文件不存在。 检查该备份是否存在，备份是否匹配实例。 400 DBS.201212 Backup ID is illegal. 备份ID非法。 检查该备份ID是否存在。 400 DBS.201214 The backup file does not exist. 备份文件不存在。 检查该备份是否存在，备份是否匹配实例。 400 DBS.201215 Time is illegal. 时间非法。 检查时间是否符合要求。 400 DBS.201319 Deleting backup file is not allowed because a restoration task is currently in progress. Please wait. 恢复时不允许删除原备份文件。 检查该备份是否正在用于恢复实例。 400 DBS.201501 The DB instance does not exist. 实例不存在或已被删除。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 400 DBS.201502 The DB instance does not exist. 实例不存在或已被删除。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 400 DBS.280308 The AZ is inconsistent. 可用区不一致。 检查实例的可用区是否与专属资源的可用区一致。 400 DBS.212001 The parameter group {0} does not exist. 参数模板不存在。 检查参数模板是否存在。 400 DBS.212003 This operation is not permitted. 暂不能进行此操作。 检查实例状态或实例正在进行的操作是否和请求冲突。 400 DBS.212006 The node associated with this parameter group is not available. 参数模板所关联节点状态异常。 检查参数模板关联的节点状态是否正常。 400 DBS.212008 The database type does not exist. 此版本数据库暂不支持。 数据库版本是否支持该操作。 400 DBS.212013 The parameter group does not exist. 参数模板不存在。 检查参数模板是否存在或是否属于当前租户。 400 DBS.212017 The parameter is invalid. 非法参数。 检查传入的参数或URL是否全部正确，是否符合要求。 400 DBS.212019 Invalid parameter. 非法参数。 检查传入的参数或URL是否全部正确，是否符合要求。 400 DBS.212028 Invalid description. 参数模板描述非法。 检查参数模板描述是否合法。 400 DBS.212030 The parameter group name already exists. 参数模板名称已存在。 检查参数模板名称是否已存在 400 DBS.212031 Invalid parameter group name. 参数模板名称非法。 检查参数模板名称是否合法。 400 DBS.212032 The operation cannot be performed because this parameter group is being applied to one or more DB instance nodes. 该操作不被允许，因为此参数模板应用于一个或多个数据库实例节点。 检查参数模板是否已经被应用到实例。 400 DBS.212035 Failed to associate this parameter group with the DB instance because the DB instance is currently being operated. 实例状态不允许。 检查实例是否正在进行其他操作。 400 DBS.212037 Parameters are incorrectly set. 参数错误。 检查参数是否合法或参数在合法范围内。 400 DBS.216016 DB instance does not exist. 实例不存在或已被删除。 检查实例是否存在。 400 DBS.216029 This operation is not allowed. 不允许的操作。 检查操作是否合法或当前接口是否支持该操作。 400 DBS.216030 The queried node does not belong to the current instance. 操作节点不属于该实例。 检查传入的节点是否归属当前实例。 400 DBS.216044 Invalid vpc cidr. 非法的VPC CIDR。 检查传入的vpc cidr格式是否合法。容灾操作场景下检查容灾实例所使用vpc的cidr是否有重叠。 400 DBS.216045 Invalid db engine version. 非法的数据库接口版本。 检查接口版本是否存在或者接口版本是否过低不支持当前操作。 400 DBS.216046 Invalid subnet cidr. 非法的子网 CIDR。 检查传入的vpc cidr格式是否合法。 400 DBS.238007 This operation cannot be performed in the current IP address status. 该IP的状态不允许进行该操作。 检查下发的IP是否已经被使用。 400 DBS.239010 Reduce num or target invalid. 缩容节点数量或缩容节点非法。 检查传入的节点是否归属当前实例。 400 DBS.239011 Reduce num invalid. 缩容节点数量非法。 检查传入的节点数量是否合理。 400 DBS.239012 Reduce target invalid. 缩容节点非法。 检查传入的节点是否归属当前实例。 400 DBS.239013 resize flavor invalid. 规格选择不合理。 检查传入的规格是否合法。 400 DBS.239014 Current disk capacity does not support scaling in the number of nodes. 当前磁盘容量下无法进行节点缩容。 检查当前实例的磁盘大小。 400 DBS.240001 node num inconsistent. 节点数量不一致。 检查节点数量是否一致。 400 DBS.240002 node num incorrect. 节点数量非法。 检查节点数量是否合法。 400 DBS.240003 Invalid billing mode. 计费模式不合法。 检查计费模式是否合法。 400 DBS.240004 Invalid subscription type. 订购周期类型不合法。 检查订购周期类型是否合法。 400 DBS.240005 Invalid validity period. 订购时长选择不合法。 检查订购时长否合法。 400 DBS.240006 Invalid renewal mode. 续订类型不合法。 检查续订类型是否合法。 400 DBS.240007 Invalid payment mode. 支付方式不合法。 检查支付方式是否合法。 400 DBS.240008 Submit order failed. 提交订单失败。 请联系客服处理。 400 DBS.240009 Deleting nodes cannot be executed in current state of the DB instance. 实例当前状态不允许节点缩容。 检查当前实例是否存在可缩容的节点。 400 DBS.240010 The selected nodes do not support shrinkage. 选择的节点不支持缩容。 检查选择的节点是否支持缩容。 400 DBS.240011 {0} 订单提交失败。 检查报错内容是否存在。 400 DBS.240012 The maximum number of resources that can be changed has been reached. 资源变动数量达到上限。 检查当前实例的节点数量是否超出限制。 400 DBS.240013 The current disk capacity cannot be changed to the target flavor. 当前磁盘容量下无法变更到目标规格。 检查当前的磁盘容量是否超出目标规格对应的磁盘容量的上限。 400 DBS.280001 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确，是否符合要求。 500 DBS.280005 Server error. Try again later. 服务器错误，请稍后重试。 联系技术支持处理。 400 DBS.280015 Permission denied. 账号权限不足。 检查token是否过期，实例是否匹配租户。 400 DBS.280016 Resource not found. 未找到资源。 检查入参是否正确，实例是否存在。 403 DBS.280019 Account suspended. 账户欠费。 检查账户余额。 403 DBS.280032 You do not have permission to perform this operation. Contact the administrator to obtain permission. 当前用户无操作权限，请联系管理员授权。 检查当前用户所在用户组的权限是否允许对应的操作。 400 DBS.280042 Invalid request. 非法请求。 检查实例当前状态及正在进行的操作是否允许该请求，请求是否合法。 400 DBS.280040 Parameter is null. 缺少参数 检查是否有参数未传入。 404 DBS.280045 This parameter group does not exist. 参数模板不存在。 检查请求中的参数模板是否存在。 403 DBS.280056 Token invalid. Token非法。 检查实例是否属于租户，token是否已经重新获取。 400 DBS.280063 You do not have following permission to perform this operation: {0}. Contact the administrator to obtain permission. 当前用户无“xxx”操作权限，请联系账户管理员授权。 检查当前用户所在用户组的权限是否允许对应的操作。 500 DBS.280064 Check PDP permissions failed. 细粒度鉴权失败。 请联系客服处理。 400 DBS.280066 Invalid log type. 非法的日志类型。 检查日志类型是否符合要求。 400 DBS.280067 Invalid start time. 非法的开始时间。 检查开始时间是否符合要求。 400 DBS.280068 Invalid end time. 非法的结束时间。 检查结束时间是否符合要求。 400 DBS.280110 The DB instance does not exist. 实例不存在或已被删除。 检查租户是否拥有该实例，实例名或实例ID是否正确，实例是否存在。 400 DBS.280122 Invalid DB engine. 存储接口非法。 检查存储接口是否和实例接口匹配。 400 DBS.280123 Invalid node number. 节点个数非法。 检查节点个数是否符合要求。 400 DBS.280124 Invalid backup. 非法的备份ID。 检查备份ID是否正确，是否符合要求。 400 DBS.280125 Invalid backup policy. 自动备份策略非法。 检查自动备份策略是否符合要求。 400 DBS.280127 Invalid backup description. 非法的备份描述。 检查备份描述是否正确，是否符合要求。 400 DBS.280200 The password contains invalid characters. 密码中包含非法字符。 检查密码是否正确，是否符合要求。 400 DBS.280214 Invalid retention period. 保留天数非法。 检查备份保留天数是否正确。 400 DBS.280215 Invalid backup cycle. 备份周期非法。 检查备份开始时间、结束时间，备份周期是否正确，是否符合要求。 400 DBS.280216 Invalid backup start time. 备份开始时间非法。 检查备份开始时间是否符合要求，备份开始时间和备份结束时间的关系是否正确。 400 DBS.280234 Invalid DB instance name. 实例名称非法。 检查实例名称是否正确，实例是否存在。 400 DBS.280235 Invalid database type. 数据库接口非法。 检查数据库接口名称是否正确。 400 DBS.280236 Invalid database version. 数据库版本非法。 检查数据库的版本号是否支持。 400 DBS.280239 Invalid specifications. 非法的规格。 检查规格码是否正确，规格在当前可用区是否存在，规格是否支持。 400 DBS.280240 The specification does not exist. 规格码不存在。 检查规格码是否正确，规格是否支持。 400 DBS.280241 Invalid storage type. 非法的磁盘类型。 检查磁盘的类型是否正确，是否符合要求。 400 DBS.280242 The storage space is out of range. 磁盘大小超出范围。 检查磁盘大小的值是否正确。 400 DBS.280244 Invalid AZ. 可用区非法。 检查可用区的参数是正确，可用区是否存在，可用区是否和规格匹配。 400 DBS.280247 Invalid VPC. VPC非法。 检查VPC ID是否正确，VPC是否存在。 400 DBS.280248 Invalid subnet. 子网非法。 检查子网ID是否正确，子网是否存在。 400 DBS.280249 Invalid security group. 安全组非法。 检查安全组ID是否正确，安全组是否存在。 400 DBS.280251 Invalid backup period. 备份周期非法。 检查备份周期是否符合要求。 400 DBS.280266 Invalid storage space. 磁盘大小非法。 检查磁盘大小的值是否正确，是否符合要求。 400 DBS.280267 Specifications not match. 规格不匹配。 检查规格信息是否正确，规格是否和实例匹配。 400 DBS.280269 Invalid Datastore Info. 非法的数据库信息。 检查数据库信息Datastore是否正确，是否符合要求。 400 DBS.280277 Invalid backup name. 备份名称非法。 检查备份名称是否正确，是否符合要求。 400 DBS.280280 Invalid DB instance number. 实例个数非法。 检查实例个数是否正确，是否符合要求。 400 DBS.280284 Invalid IP address. IP非法。 检查IP是否正确，是否符合要求。 400 DBS.280292 Invalid database username. 用户名非法。 检查用户名是否正确，是否符合要求。 400 DBS.280311 Invalid storage space. 磁盘大小非法。 检查磁盘大小的值是否正确，是否符合要求。 400 DBS.280314 Invalid storage space. 磁盘类型非法。 检查磁盘类型是否正确，是否符合要求，实例是否支持该磁盘类型。 400 DBS.280327 Invalid node type. 节点类型非法。 检查节点类型是否正确，是否符合要求，节点类型与实例是否匹配，节点类型与组ID、节点ID是否匹配。 400 DBS.280341 Invalid DB instance type. 实例数据库类型非法。 检查操作实例是否为云数据库 GeminiDB接口所支持的实例。 400 DBS.280342 Invalid DB instance mode. 实例模式非法。 检查实例模式是否正确，是否符合要求，实例模式与实例ID是否匹配。 400 DBS.280347 Unsupported database type. 数据库类型不支持。 检查实例类型是否正确，是否符合要求。 400 DBS.280365 Invalid payment mode. 非法的付费模式。 检查付费模式是否正确，是否符合要求。 400 DBS.280366 Invalid order ID. 非法的订单号。 检查包周期订单号是否传入，是否符合要求。 400 DBS.280391 Action check states. 非法的操作 检查输入的action是否符合要求。 400 DBS.280404 Invalid DB instance ID. 非法的实例ID。 检查实例ID是否正确，是否符合要求。 403 DBS.280406 The DB instance cannot be deleted. 不允许删除实例。 检查实例接口和计费方式是否支持直接删除实例。 400 DBS.280407 Invalid node ID. 非法的节点ID。 检查节点ID是否正确，是否符合要求。 400 DBS.280408 Invalid project id. 非法的项目ID。 检查项目ID是否正确，是否符合要求。 400 DBS.280414 Invalid group type. 非法的组类型。 检查组类型是否正确，是否符合要求，组类型与实例是否匹配，组类型与组ID是否匹配。 400 DBS.280416 Invalid backup end time. 备份结束时间非法。 检查是否缺失备份结束时间，检查备份结束时间周期、格式是否满足要求。 400 DBS.280421 Invalid EIP. 弹性公网IP非法。 检查弹性公网IP是否存在，是否符合要求。 403 DBS.280433 Invalid enterprise project ID. 企业项目ID无效。 检查企业项目ID是否符合要求。 400 DBS.280434 The specifications are unavailable. 资源规格编码无效。 检查资源规格编码是否存在，是否符合要求。 400 DBS.280437 Not support enterprise project. 不支持企业项目。 当前用户尚未开通企业项目服务，请开启企业项目服务或不传入相关参数。 400 DBS.280438 Invalid encryption key. 磁盘加密密钥ID无效。 检查请求中的磁盘加密密钥ID是否已经创建并且状态可用，当前接口是否支持磁盘加密。 400 DBS.280439 Invalid limit. 限制查询数量不正确。 检查参数“limit”值设置是否符合要求。 400 DBS.280440 Invalid offset. 偏移量不正确。 检查参数“offset”值设置是否符合要求。 400 DBS.280441 Invalid key. 标签key无效。 检查标签key是否符合要求。 429 DBS.280443 The maximum number of connections has been reached. 超出最大连接数。 同一租户调用接口请求过于频繁，请降低频率。 400 DBS.280444 Invalid value. 标签value无效。 检查标签value是否符合要求。 400 DBS.280445 The DB instance class is not available. 实例规格不可用。 当前实例规格不可用，请更换为其他规格。 400 DBS.280446 The database information does not exist. 数据库信息不存在。 检查“datastore”字段是否存在。 400 DBS.280453 Invalid DSS storage pool ID. 专属存储池ID无效。 检查专属存储池ID是否正确 400 DBS.280465 Invalid password. 用户密码非法。 检查用户密码是否符合要求。 400 DBS.280469 Invalid E CS group policy. 非法的云服务器组关联策略。 检查云服务器组关联策略是否正确 400 DBS.280480 The target specification is same as current. 目标规格与当前规格相同。 检查目标规格是否与当前规格相同。 400 DBS.280456 This operation is not supported by the current billing mode. 当前计费模式不支持该操作。 检查当前实例的计费模式， 是否符合接口要求。 400 DBS.290000 Parameter error. 参数错误。 检查传入的参数或URL是否全部正确，是否符合要求。 400 DBS.301024 Invalid backup restore information. 无效的备份恢复信息。 检查备份恢复信息是否合法。 400 DBS.301040 The target security group is same as current. 目标安全组与当前安全组相同。 检查目标安全组是否与当前安全组相同。 400 DBS.301071 Invalid session id. 非法会话ID。 检查会话ID是否正确，是否符合要求。 400 DBS.301072 Invalid plan summary. 非法执行计划。 检查执行计划是否正确，是否符合要求。 400 DBS.301073 Invalid operation type. 非法操作类型。 检查操作类型是否正确，是否符合要求。 400 DBS.301074 Invalid namespace. 非法命名空间。 检查命名空间是否正确，是否符合要求。 400 DBS.301075 Invalid cost time. 非法执行时间。 检查执行时间是否正确，是否符合要求。 400 DBS.301076 Query session failed. 查询会话失败。 检查实例状态，请联系客服处理。 400 DBS.301077 Kill session failed. 终结会话失败。 检查实例状态，请联系客服处理。 400 DBS.03000001 The instance has not build biactive relationship. 实例尚未搭建双活关系。 检查实例状态是否搭建双活关系。 400 DBS.03000002 Invalid threshold. 阈值输入错误。 检查传入的阈值是否符合规范。 400 DBS.03000003 Invalid step. 自动扩容步长输入错误。 检查传入的步长是否符合规范。 400 DBS.03000004 Invalid switch option. 开关输入形式错误。 检查输入的开关是否为“on”或者“off”。

URI GET https://{Endpoint}/v3/{project_id}/datastores/{datastore_name}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 datastore_name 是 String 参数解释： 数据库类型。 约束限制： 不涉及。 取值范围： GeminiDB Cassandra数据库实例，取值为“cassandra”。 GeminiDB Mongo数据库实例，取值为“mongodb”。 GeminiDB Influx数据库实例，取值为“influxdb”。 GeminiDB Redis数据库实例，取值为“redis”。 默认取值： 不涉及。

响应示例 状态码： 200 Success. { "total_count" : 1, "instances" : [ { "id" : "07fc12a8e0e94df7a3fcf53d0b5e1605in06", "name" : "test", "mode" : "Cluster", "datastore" : { "type" : "cassandra", "version" : "3.11" }, "charge_mode" : "postPaid", "enterprise_project_id" : "0", "backup_id" : "bf9ee62a7f7044c583c6765c916c36edbr02", "created_at" : "2022-01-01T10:00:00", "deleted_at" : "2022-02-01T11:00:00", "retained_until" : "2022-02-02T11:00:00" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 总记录数。 instances Array of objects 实例信息。详情请参考表5。 表5 RecycleInstance 参数 参数类型 描述 id String 实例ID。 name String 实例名称。 mode String 实例类型。 取值为“Cluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis 经典部署模式Proxy 集群实例类型。 取值为“CloudNativeCluster”，表示GeminiDB Cassandra、GeminiDB Influx、GeminiDB Redis云原生部署模式集群实例类型。 取值为“RedisCluster”，表示GeminiDB Redis经典部署模式Cluster集群实例类型。 取值为“Replication”，表示GeminiDB Redis经典部署模式主备实例类型。 取值为“InfluxdbSingle”，表示GeminiDB Influx 经典部署模式单节点实例类型。 取值为“ReplicaSet”，表示GeminiDB Mongo副本集实例类型。 product_type String 产品类型。 GeminiDB Redis云原生部署模式集群涉及此字段，取值： Standard 标准型 Capacity 容量型 datastore object 数据库信息。详情请参考表6。 charge_mode String 计费方式。 prePaid：预付费，即包年/包月。 postPaid：后付费，即按需付费。 enterprise_project_id String 企业项目ID，取值为“0”，表示为default企业项目。 backup_id String 备份ID。 created_at String 实例创建时间。 deleted_at String 实例删除时间。 retained_until String 回收备份保留截止时间。 表6 RecycleDatastore 参数 参数类型 描述 type String 数据库类型。 取值为“cassandra”，表示GeminiDB Cassandra数据库实例。 取值为“mongodb”，表示GeminiDB Mongo数据库实例。 取值为“influxdb”，表示GeminiDB Influx数据库实例。 取值为“redis”，表示GeminiDB Redis数据库实例。 version String 数据库版本。

URI GET https://{Endpoint}/v3/{project_id}/recycle-instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询） 取值必须为数字，且不能为负数。 limit 否 Integer 查询个数上限值。 取值范围：1~100。 不传该参数时，默认查询前100条信息。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 recycle_policy 是 object 回收策略。详情强参考表4。 表4 RecyclePolicy 参数 是否必选 参数类型 描述 retention_period_in_days 否 Integer 策略保持时长（1-7天），天数为正整数，默认7天。

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/recycle-policy 设置回收站实例保留天数为3天 { "recycle_policy": { "retention_period_in_days": 3 } }

请求示例 URI样例 PUT https://gaussdb-nosql.cn-north-4.myhuaweicloud.com/v3/375d8d8fad1f43039e23d3b6c0f60a19/instances/9136fd2a9fcd405ea4674276ce36dae8in02/backups/policy 请求体样例 开启或修改自动备份策略，备份周期为"1,2,3,4,5,6"，备份时间段为"01:00-02:00",备份保留天数为7天： { "backup_policy" : { "period" : "1,2,3,4,5,6", "start_time" : "01:00-02:00", "keep_days" : 7 } } 关闭自动备份策略： { "backup_policy" : { "keep_days" : 0 } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 backup_policy 是 object 备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表4。 表4 BackupPolicy 参数 是否必选 参数类型 描述 keep_days 是 Integer 指定已生成的备份文件可以保存的天数。 取值范围：0～35。取0值，表示关闭自动备份策略。 start_time 否 String 备份时间段。自动备份将在该时间段内触发。开启自动备份策略时，该参数必选；关闭自动备份策略时，不传该参数。 取值范围：格式必须为hh:mm-HH:MM，且有效，当前时间指UTC时间。 HH取值必须比hh大1。 mm和MM取值必须相同，且取值必须为00、15、30、45。 取值示例：23:00-00:00。 period 否 String 备份周期配置。自动备份将在每星期指定的天进行。启用自动备份策略时，此参数必选。如果自动备份策略关闭，则不需要传递该参数。 取值范围：格式为半角逗号隔开的数字，数字代表星期。保留天数取值不同，备份周期约束如下： 指定已生成的备份文件可以保存的天数为0天，不传该参数。 指定已生成的备份文件可以保存的天数为1～6天，备份周期全选，取值为：1,2,3,4,5,6,7。 指定已生成的备份文件可以保存的天数为7～35天，备份周期至少选择一周中的一天。示例：1,2,3,4。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 backup_policy object 备份策略对象，包括备份保留的天数和备份开始时间。详情请参考表5。 表5 ShowBackupPolicyResult 参数 参数类型 描述 keep_days Integer 备份文件可以保存的天数。 start_time String 备份时间段。自动备份将在该时间段内触发。 period String 备份周期配置。自动备份将在每星期指定的天进行。

URI GET https://{Endpoint}/v3.1/{project_id}/instances/{instance_id}/backups/policy 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 instance_id 是 String 实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 type 否 String 备份策略类型。该参数仅针对GeminiDB Cassandra。可取值： Instance，表示查询实例级备份。 DatabaseTable，表示查询库表级备份。 默认取值“Instance”。

响应示例 状态码： 200 Success 自动备份策略开启： { "backup_policy" : { "keep_days" : 7, "start_time" : "19:00-20:00", "period" : "1,2,4,5,6" } } 自动备份策略关闭： { "backup_policy" : { "keep_days" : 0 } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 enabled Boolean true：开启，false：关闭。 type String 类型选项。 取值： whiteList：白名单，只允许指定ip或网段访问。 blackList：黑名单，不允许指定ip或网段访问。 ip_groups Array of objects IP地址组中包含的IP或网段列表。详情请参考表4。 表4 IpGroupItem 参数 参数类型 描述 ip String IP地址或网段。支持IPv4、IPv6。 description String 备注信息。长度：最小长度 0，最大长度 255。

请求示例 ip网段123.123.123.0/24被设置成黑名单 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control { "type" : "blackList", "enabled" : true, "ip_groups" : [ { "ip" : "123.123.123.0/24", "description" : "test" } ] } 关闭负载均衡黑白名单 PUT https://{Endpoint}/v3/054e292c9880d4992f02c0196d3ea468/instances/054e292c9880d4992f02c0196d3ein12/lb/access-control { "type" : "blackList", "enabled" : false, "ip_groups" : [ { "ip" : "123.123.123.123", "description" : "test" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 enabled 是 Boolean true：开启，false：关闭。 type 是 String 类型选项。 取值： whiteList：白名单，只允许指定ip或网段访问。 blackList：黑名单，不允许指定ip或网段访问。 ip_groups 是 Array of objects IP地址组中包含的IP或网段列表。详情请参考表4。 表4 IpGroupItem 参数 是否必选 参数类型 描述 ip 是 String IP地址或网段。支持IPv4、IPv6。 description 否 String 备注信息。长度：最小长度 0，最大长度 255。

响应示例 状态码： 200 Success { "schedules" : [ { "job_id" : "56d3c1138dcf4f1da73b0170700c78d0", "job_name" : "REBOOT", "job_status" : "Pending", "instance_id" : "8a6117ece8a0457a90060441fa372e8ein06", "instance_name" : "gauss-nosql", "instance_status" : "normal", "datastore_type" : "GeminiDB Cassandra", "create_time" : "2019-05-26T10:41:14+0000", "start_time" : "2019-05-26T12:41:14+0000", "end_time" : "2019-05-26T12:51:14+0000" } ], "total_count" : 1 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total_count Integer 记录总数。 schedules Array of objects 任务详情。详情请参考表5。 表5 ScheduleDetailInfo 参数 参数类型 描述 job_id String 任务ID。 job_name String 任务名称。对应取值如下： REBOOT：重启实例。 RESIZE_FLAVOR：变更实例的CPU和内存规格。 UPGRADE_DATABASE：补丁升级。 job_status String 任务执行状态。取值： Pending：表示任务未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 Canceled：表示任务取消执行。 instance_id String 实例ID。 instance_name String 实例名称。 instance_status String 实例状态。取值： Createfail：表示实例创建失败。 Creating：表示实例创建中。 Normal：表示实例正常。 Abnormal：表示实例异常。 Deleted：表示实例已删除。 datastore_type String 数据库类型。 create_time String 任务创建时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 start_time String 任务开始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。 end_time String 任务结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100。

URI GET https://{Endpoint}/v3/{project_id}/scheduled-jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 用户在某一region下的project Id。 表2 Query参数 参数 是否必选 参数类型 描述 job_name 否 String 任务名称，默认为空。对应取值如下： REBOOT：重启实例。 RESIZE_FLAVOR：变更实例的CPU和内存规格。 UPGRADE_DATABASE：补丁升级。 job_status 否 String 任务执行状态，默认为空。取值： Pending：表示任务未执行。 Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 Canceled：表示任务取消执行。 instance_id 否 String 实例ID，不传该值默认查询所有符合条件的实例。 start_time 否 String 任务创建起始时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传该值默认为当前时间前七天。 end_time 否 String 任务创建结束时间，格式为"yyyy-mm-ddThh:mm:ssZ"。其中，T指某个时间的开始；Z指时区偏移量，例如偏移1个小时显示为+0100，不传该值默认为当前时间。 offset 否 Integer 索引位置，偏移量。从第一条数据偏移offset条数据后开始查询，默认为0。 limit 否 Integer 查询记录数。不传该参数时，默认为10，取值范围1-100。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of 表5 objects 任务列表。 total_count Integer 任务列表总数。 表5 JobDetail 参数 参数类型 描述 id String 任务ID。 name String 任务名称。 status String 任务执行状态。取值： Running：表示任务正在执行。 Completed：表示任务执行成功。 Failed：表示任务执行失败。 start_time String 创建时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 end_time String 结束时间，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始；Z指时区偏移量，例如北京时间偏移显示为+0800。 progress String 任务执行进度。 说明： 执行中状态才返回执行进度，例如“60%”，表示任务执行进度为60%，否则返回“”。 instance 表6 object 任务关联的实例信息。 fail_reason String 任务执行失败时的错误信息。 表6 JobInstanceInfo 参数 参数类型 描述 id String 实例ID。 name String 实例名称。

响应示例 状态码： 200 Success { "total_count" : 1, "jobs" : [ { "id" : "6f85e061-04dd-42e7-86d6-d3b1e40aac2e", "name" : "CreateCassandra", "status" : "Running", "start_time" : "2023-09-12T06:44:01+0000", "end_time" : "2023-09-12T06:44:03+0000", "progress" : "14%", "instance" : { "id" : "27a045b6bf9e46f691f81366d398cb04in06", "name" : "nosql-12f5" }, "fail_reason" : "" } ] }

URI GET https://{Endpoint}/v3/{project_id}/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一region下的project ID。获取方法请参见获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 id 否 String 任务ID。 start_time 否 String 查询开始时间，默认当前时间往前30天，格式为“yyyy-mm-ddThh:mm:ssZ”。 其中，T指某个时间的开始，Z指时区偏移量。 end_time 否 String 查询结束时间，默认当前时间，格式为“yyyy-mm-ddThh:mm:ssZ”，且大于查询开始时间，时间跨度不超过30天。 其中，T指某个时间的开始，Z指时区偏移量。 status 否 String 任务状态。取值为“Running”为执行中。取值为“Completed”为完成。取值为“Failed”为失败。 name 否 String 任务名称。对应取值如下： "CreateInstance"：创建实例。 "RestoreNewInstance"：恢复到新实例。 "EnlargeInstance"：扩容实例。 "ReduceInstance"：缩容实例。 "RestartInstance"：重启实例。 "RestartNode"：重启节点。 "EnlargeInstanceVolume"：扩容实例磁盘。 "ReduceInstanceVolume"：缩容实例磁盘。 "ResizeInstance"：规格变更实例。 "UpgradeDbVersion"：升级数据库版本。 "BindPublicIP"：绑定公网IP。 "UnbindPublicIP"：解绑公网IP。 "DeleteInstance"：删除实例。 "EnlargeInstanceColdVolume"：扩容实例冷存储。 "AddInstanceColdVolume"：增加实例冷存储。 "ModifySecurityGroup"：修改安全组。 "ModifyCcmCert"：修改CCM证书。 "ModifyPort"：修改端口。 "ConstructDisasterRecovery"：构造容灾关系。 "DeConstructDisasterRecovery"：解除容灾关系。 "SwitchOverDisasterRecovery"：切换容灾关系。 "BuildBiActiveInstance"：构建双活实例。 "ReleaseBiActiveInstance"：解除双活实例关系。 "BackupInstance"：备份实例。 offset 否 Integer 索引位置，偏移量。 从第一条数据偏移offset条数据后开始查询，默认为0（偏移0条数据，表示从第一条数据开始查询），必须为数字，不能为负数。 limit 否 Integer 查询记录数。取值10，20，50 ，默认为50。

URI DELETE https://{Endpoint}/v3/{project_id}/instances/{instance_id}/dual-active-relationship 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 搭建双活 URI样例 POST https://gaussdb-nosql.cn-north-7.myhuaweicloud.com/v3/054e292c9880d4992f02c0196d3ea468/instances/a4d8ea2584e047439a667703c0684119in06/dual-active-relationship { "destination_region" : "cn-north-4", "destination_instance_id" : "a4d8ea2584e047439a667703c0684119in06" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释： 用户Token。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 表3 请求Body参数 参数 是否必选 参数类型 描述 destination_region 是 String 参数解释： 搭建双活目标实例所在的region。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 destination_instance_id 是 String 参数解释： 搭建双活目标实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

URI POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/dual-active-relationship 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 instance_id 是 String 参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。

请求示例 默认查询50个实例容灾切换的故障节点比例。 GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings 查询实例容灾切换的故障节点比例。 GET https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/disaster-recovery/settings?offset=0&limit=50&instance_id=d74162b942604190b991d1c39772a66ain06&instance_id=e74162b942604190b991d1c39772a66ain06

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 disaster_recovery_settings Array of SwitchoverRatio objects 容灾切换的故障节点比例列表。 total_count Integer 总记录数。 表5 SwitchoverRatio 参数 参数类型 描述 instance_id String 实例ID。 switchover_ratio Integer 容灾切换的故障节点比例，下限是50，步长是10，最大是100，默认为100。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误消息。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 错误消息。