該接口用于查詢RDS MySQL全球多活數據庫集群列表或目標集群的詳細信息。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| rds:DescribeGadInstances | get | *GadInstance acs:rds::{#accountId}:gadinstance/* |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| GadInstanceName | string | 否 | RDS 全球多活數據庫集群 ID。
說明
您可在第一次調用時不傳入此參數獲取當前賬號下的所有集群 ID，再通過傳入集群 ID 查看該集群的詳情。
| gad-rm-bp1npi2j8**** |
| RegionId | string | 否 | 地域 ID，可調用 DescribeRegions 查詢。 | cn-hangzhou |
| ResourceGroupId | string | 否 | 資源組 ID。 | rg-acfmy**** |
返回參數
示例
正常返回示例
JSON格式
{
"GadInstances": [
{
"CreationTime": "2021-10-21T02:57:08Z",
"Description": "GadTest",
"GadInstanceMembers": [
{
"DBInstanceID": "rm-bp1npi2j8****",
"DtsInstance": "{\\\"dtsInstanceId\\\":\\\"dtsm9t107c****\\\",\\\"dtsRequestId\\\":\\\"190F0C6C-4BE6-5676-989B-DBDE6D34CD9C\\\"}",
"Engine": "mysql",
"EngineVersion": "8.0",
"RegionId": "cn-hangzhou",
"ResourceGroupId": "rg-acfmy****",
"Role": "CENTRAL",
"Status": "activation"
}
],
"GadInstanceName": "gad-rm-bp1npi2j8****",
"ModificationTime": "2021-10-21T03:01:20Z",
"Service": "mysql",
"Status": "activation"
}
],
"RequestId": "76AF0609-4195-5DFC-BC78-3AD76FF872BB"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | Order.ComboInstanceNotAllowOperate | A package instance is not allowed to operate independently. | 套餐實例不允許單獨操作。 |
| 400 | Price.PricingPlanResultNotFound | Pricing plan price result not found. | 定價計劃價格結果沒有找到。 |
| 400 | Order.NoRealNameAuthentication | You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication. | 您還未通過實名認證，不符合購買條件，請登錄費用與成本進行實名認證。 |
| 400 | InsufficientAvailableQuota | Your account quota limit is less than 0, please recharge before trying to purchase. | 您的賬戶可用額度小于0，請先充值后再嘗試購買。 |
| 400 | CommodityServiceCalling.Exception | Failed to call commodity service. | 調用商品服務返回失敗。 |
| 400 | RegionDissolvedEOM | Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support. | 客戶您好，阿里云計劃對當前地域進行優化調整，該區域云服務將停止運營，為確保您的業務連續性及數據遷移工作的平穩過渡，您目前無法操作新購類型的訂單，感謝理解與支持。 |
| 400 | Commodity.InvalidComponent | The module you purchased is not legal, please buy it again. | 您購買的模塊不合法，請重新購買。 |
| 400 | RegionEndTimeDissolvedAustralia | Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024. | 客戶您好，該地域已裁撤。 |
| 400 | Price.CommoditySys | Commodity system call exception. | 商品系統調用異常。 |
| 400 | Pay.InsufficientBalance | Insufficient available balance. | 可用金不足。 |
| 400 | Order.PeriodInvalid | There is a problem with the period you selected, please choose again. | 您選購的周期有問題，請重新選購。 |
| 400 | pay.noCreditCard | Account not bound to credit card. | 賬戶未綁定信用卡。 |
| 400 | Order.InstHasUnpaidOrder | There is an unpaid order for the service you have purchased. Please pay or void it before placing the order. | 您選購的服務存在未支付訂單，請支付或作廢后再下單。 |
| 400 | noAvailablePaymentMethod | No payment method is specified for your account. We recommend that you add a payment method. | 沒有為您的帳戶指定付款方式。我們建議您添加一種付款方式。 |
| 400 | BasicInfoUncompleted | Your information is incomplete. Complete your information before the operation. | 您的基本信息未完善，請在操作前先完善您的基本信息。 |
| 400 | Risk.RiskControlRejection | Your account is abnormal, please contact customer service for details. | 您的賬戶出現異常，詳情請聯系客服。 |
| 400 | BasicInfoUncompleted | Your information is incomplete, Complete your information before the operation. | 您的信息不完整，請在操作前填寫您的信息。 |
| 400 | Api.NotSupport | Specified api is not supported. | 當前接口不支持。 |
| 400 | ContainForbiddenLabelError | There is a label that prohibits placing orders. Please contact your distributor for assistance. | 存在禁止下單的標簽，請聯系您的分銷商處理 |
| 400 | InvalidDBInstanceId.NotFound | The DBInstanceId provided does not exist in records. | 提供的DBInstanceId不存在。 |
| 400 | InvalidInstanceLevel.DiskType | Specified instance level not support request disk type | 當前實例規格不支持該存儲類型。 |
| 400 | InvalidParam | Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica. | 指定的 wal_level 參數無效。實例中仍然存在復制槽，因此無法將其設置為replica。 |
| 400 | KmsApiError | User secret key invalid. | 用戶密鑰失效。 |
| 400 | System.SaleValidateFailed | Sales expression validation system error. | 銷售表達式校驗系統錯誤。 |
| 400 | Abs.InvalidAccount.NotFound | account is not found. | 賬戶不存在。 |
| 400 | SqlExecuteFailedOrTimeout | sql command execution failed or timed out:%s. | sql命令執行失敗或執行超時 |
| 400 | ColdData.EngineVersionNotSupport | The current instance engine version not support coldDataEnabled. | 當前實例引擎版本不支持歸檔冷數據。 |
| 400 | ColdData.MinorVersionNotSupport | The current instance minor version not support coldDataEnabled. | 當前內核版本不支持歸檔冷數據。 |
| 400 | IncorrectTargetClasscode | The current instance type does not support this operation. | 當前規格不支持此操作。 |
| 400 | InvalidConnectionString.Duplicate | Specified connection string already exists in the RDS. | 鏈接地址名重復，請重新設置連接字符串。 |
| 400 | RequiredParam.NotFound | Required input param is not found. | 沒有傳入必要的參數。 |
| 400 | Parameters.Invalid | Parameter error, please check the parameters. | 參數錯誤，請檢查參數。 |
| 400 | BackupPolicyNotSupport | Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy. | 數據歸檔不支持跨地域備份和秒級快照，請檢查備份策略。 |
| 400 | InvalideStatus.Format | The instance status does not support this operation. | 實例狀態不支持此操作。 |
| 400 | InvalidReleasedKeepPolicy.Format | Specified Released Keep Policy is not valid. | 實例釋放后的歸檔備份保留策略無效。 |
| 400 | InvalidDBInstanceEngineType.Format | the DB instance engine type does not support this operation. | DB實例引擎類型不支持此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | 無信用卡。 |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | vpc網絡類型實例不支持此操作。 |
| 400 | MirrorInsExists | Specified DB instance mirror ins already existed. | 當前數據庫實例鏡像已存在。 |
| 400 | UnsupportedClassCode | The specified DB instance class stops selling. | 實例規格停止售賣。 |
| 400 | InvalidBackupSet | The specified database does not exist in the backup set. | 備份集中沒有指定的數據庫。 |
| 400 | OrdTCommodityQueryError | Failed to query for product. | 查詢產品失敗。 |
| 400 | ProductInstanceReleased | The instance has been released. Please check before placing the order. | 實例已釋放，請核實后下單。 |
| 400 | RegionEndTimeDissolvedIndia | The region is no longer supported. | 指定的地域無效。 |
| 403 | OrderStatus.UnPaid | The specified db instance has unpaid order. | 實例當前存在未支付訂單，請支付后重試。 |
| 403 | InvalidReduceDiskSize | The storage capacity after the scale-down must be larger than the used amount. | 縮容目標容量不能小于當前存儲空間使用量 |
| 403 | CloudSSDNotSupport | Cloud ssd does not support this operation, please upgrade to essd. | SSD盤不支持此操作，請升級至ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 用戶權限不支持此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或為空 |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 當前引擎小版本不支持此操作。 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 沒有可用的庫存區域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集團上云用戶不可用，無權限。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 當前數據庫實例級別不支持此操作。 |
| 404 | InvalidClusterKms | The current instance does not authorized to access the Key Management Service. | 當前實例未授權訪問密鑰管理服務。 |
| 404 | Request.NotFound | The requested resource is not available. | 請求的資源不可用。 |
| 404 | HostInfo.NotFound | The specified host info is not found. | 指定的主機信息不存在。 |
| 500 | ExternalFailure | The request processing has failed due to external service failure. | 請求服務失敗，請稍后重試。 |
| 500 | RequestMetaDataFailed | The service request failed. Please try again later or contact service personnel. | 請求服務失敗，請稍后再試或聯系服務人員。 |
| 500 | InvokeProxyFailure | The request processing has failed due to service failure of rds api. | 由于rds api服務失敗，請求處理失敗。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-03-14 | OpenAPI 返回結構發生變更 | 查看變更詳情 |