huawei-cloud-api-definitions-GaussDBforNoSQL 0.1.20240210

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ErrorResponseBody":{"properties":{"error_code":{"description":"错误码。","example":"DBS.200001","type":"string"},"error_msg":{"description":"错误消息。","example":"参数错误。","type":"string"}},"required":["error_code","error_msg"]},"PrecheckDisasterRecoveryInstance":{"properties":{"node_ips":{"description":"与当前实例建立容灾关系实例的节点IP列表。","items":{"type":"string"},"type":"array"},"spec_code":{"description":"与当前实例建立容灾关系实例的规格码。","type":"string"},"vpc_cidr":{"description":"与当前实例建立容灾关系实例的vpc网段。","type":"string"}},"required":["vpc_cidr","spec_code","node_ips"]},"PrecheckDisasterRecoveryOperationBody":{"properties":{"disaster_recovery_instance":{"$ref":"#/definitions/PrecheckDisasterRecoveryInstance","description":"与当前实例建立容灾关系的实例信息。","type":"object"},"operation":{"description":"指定预校验的具体容灾操作。","type":"string"}},"required":["operation"]}},"description":null,"group_id":"e59009abc8d6499f9f8dc004e69d73d7","host":"gaussdb-nosql.cn-north-4.myhuaweicloud.com","id":"f54d1a888957482dacfbae6f2d7d7388","info_version":"v3","method":"post","name":"CheckDisasterRecoveryOperation","parameters":{},"paths":{"/v3/{project_id}/instances/{instance_id}/disaster-recovery/precheck":{"post":{"description":"校验实例是否可以与指定实例建立/解除容灾关系。若接口返回成功,表示可以与指定实例建立/解除容灾关系。\n该接口需要对建立/解除容灾关系的两个实例各调用一次,2次调用都响应成功才能进行容灾关系的搭建/解除。","operationId":"CheckDisasterRecoveryOperation","parameters":[{"description":"用户Token。","in":"header","name":"x-auth-token","required":true,"type":"string","x-example":"******"},{"description":"租户在某一region下的project ID。","in":"path","name":"project_id","required":true,"type":"string","x-example":"619d3e78f61b4be68bc5aa0b59edcf7b"},{"description":"实例ID。","in":"path","name":"instance_id","required":true,"type":"string","x-example":"ee5589ad2a234b329f80dcfbe4676ad4in12"},{"description":"请求体。","in":"body","name":"PrecheckDisasterRecoveryOperationBody","required":true,"schema":{"$ref":"#/definitions/PrecheckDisasterRecoveryOperationBody"}}],"responses":{"204":{"description":"Success."},"default":{"description":"Client or server error.","schema":{"$ref":"#/definitions/ErrorResponseBody"}}},"summary":"校验实例是否可以与指定实例建立/解除容灾关系","tags":["容灾管理"],"x-apigateway-ratelimit":"nosql_default_policy","x-constraint":"该接口支持GeminiDB Redis数据库实例。\nGeminiDB Redis主备版实例暂不支持该接口。","x-is-registered":"Y","x-request-examples-1":{"disaster_recovery_instance":{"node_ips":["10.0.0.2","10.0.0.3","10.0.0.4"],"spec_code":"geminidb.redis.xlarge.4","vpc_cidr":"10.0.0.0/16"},"operation":"construction"},"x-request-examples-2":{"operation":"deconstruction"},"x-request-examples-description-1":"校验实例是否可以与特定实例建立容灾关系。","x-request-examples-description-2":"校验实例是否可以与特定实例解除容灾关系。","x-request-examples-url-1":"POST https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f90458c41aea4c26a9dcbb5740f2ff76in12/disaster-recovery/precheck","x-request-examples-url-2":"POST https://{endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/f90458c41aea4c26a9dcbb5740f2ff76in12/disaster-recovery/precheck","x-support-sdk":"Y"}}},"product_short":"GaussDBforNoSQL","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"校验实例是否可以与指定实例建立/解除容灾关系","tags":"容灾管理","uri":null,"version":"2.0"}