該介面用於為 RDS 叢集系列執行個體建立 Endpoint。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
rds:CreateDBInstanceEndpoint |
create |
*DBInstance。
|
|
無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClientToken |
string |
否 |
該參數用於保證請求的冪等性,防止重複提交請求。參數值由用戶端產生,保證在不同請求間唯一。 該參數值由 ASCII 字元組成,最長不超過 64 個字元,不能包含非 ASCII 字元。 |
6000170000591aed949d0f**** |
| DBInstanceId |
string |
是 |
執行個體 ID。可呼叫 DescribeDBInstances 查詢。 |
rm-**** |
| VpcId |
string |
是 |
內網連線的 VPC ID。 |
vpc-xxxmmxjqqi**** |
| VSwitchId |
string |
是 |
內網連線的交換器 ID。 |
vsw-bp1kqp**** |
| PrivateIpAddress |
string |
否 |
內網連線的 IP 位址。 |
172.16.XX.XX |
| ConnectionStringPrefix |
string |
是 |
內網連線位址首碼。 建立 Endpoint 的同時會自動建立一個內網連線位址,該參數表示內網連線位址的首碼。 |
rm-****-ro |
| Port |
string |
是 |
內網連線連接埠號。建立內網連線支援自訂連接埠號。 取值範圍:3000~5999 |
3306 |
| DBInstanceEndpointType |
string |
是 |
Endpoint 類型,取值含義如下:
枚舉值:
|
Readonly |
| DBInstanceEndpointDescription |
string |
否 |
使用者自訂的 Endpoint 描述。 |
for readonly business |
| NodeItems |
array<object> |
是 |
Endpoint 節點相關資訊清單。 |
|
|
object |
否 |
Endpoint 節點詳細資訊。 |
||
| DBInstanceId |
string |
是 |
執行個體 ID。可呼叫 DescribeDBInstances 查詢。 |
rm-**** |
| NodeId |
string |
是 |
節點 ID。 |
rn-xxxx-**** |
| Weight |
integer |
否 |
節點目前權重取值,按照該取值分配讀取流量。 取值範圍:0~100 |
50 |
| ResourceGroupId |
string |
否 |
資源群組 ID。可呼叫 DescribeDBInstanceAttribute 取得。 |
rg-acfmy**** |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
傳回參數詳細資訊。 |
||
| Data |
object |
傳回資料清單。 |
|
| ConnectionString |
string |
內網連線位址。 |
rm-****.mysql.rds.aliyuncs.com |
| DBInstanceEndpointId |
string |
執行個體的 Endpoint ID。 |
ep-**** |
| DBInstanceName |
string |
執行個體 ID。 |
rm-**** |
| RequestId |
string |
請求 ID。 |
C8E88DED-533F-4B3C-9207-731FBF394CCA |
樣本
正常返回樣本
JSON格式
{
"Data": {
"ConnectionString": "rm-****.mysql.rds.aliyuncs.com",
"DBInstanceEndpointId": "ep-****",
"DBInstanceName": "rm-****"
},
"RequestId": "C8E88DED-533F-4B3C-9207-731FBF394CCA"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InvalidSourceCategory | specified source category is invalid. | 指定的來源類別無效。 |
| 400 | InvalidDBInstanceConnType.Format | Specified DB instance conn type is not valid. | 當前資料庫執行個體的連線類型不支援此操作。 |
| 400 | EndpointNum.Error | The number of endpoint is too many. | 目前終端數量不符合要求,請檢查支援的終端數量。 |
| 400 | InvalidNodeItems.DuplicateNodeId | Duplicate nodeId, please ensure all nodeIds are different. | NodeItems參數中有重複的NodeId。 |
| 400 | InvalidNodeItems.RONode | ReadOnly endpoint can not contain readonly instance node. | 唯讀endpoint不能包含唯讀執行個體的節點。 |
| 400 | InvalidNodeItems.RONodeIdPrimary | ReadOnly endpoint can not contain primary node. | 唯讀endpoint不能包含primary節點。 |
| 400 | InvalidNodeItems.JsonFormat | NodeItems is not a json string. | NodeItems要求是一個JSON字串。 |
| 400 | InvalidNodeItems.DBInstanceId | Specified dbInstanceId is invalid | NodeItems中的dbInstanceId無效。 |
| 400 | InvalidNodeItems.NodeId | Specified Node id is invalid | NodeItems中存在NodeId不在叢集節點中。 |
| 400 | EndpointType.NotSupport | Current db type is not support specified endpoint type. | 不支援傳入的Endpoint的類型。 |
| 400 | OtherEndpoint.Exist | Other endpoint already exist. | 連線位址的前綴已存在。 |
| 400 | InvalidPort.Malformed | Specified port is not valid. | 指定的連接埠無效。 |
| 400 | APICallingFailed | Api called failed, please check vpc vsw vip | 後端API內部呼叫失敗。 |
| 400 | InvalidDBInstanceName.NotFound | The specified DB instance name does not exist. | 該執行個體ID不存在,請確認後重試。 |
| 400 | InvalidNodeItems.BlackNodeItems | NodeItems is blank. | 節點資料不能為空。 |
| 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 | 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. | 指定的執行個體不存在,請檢查該執行個體是否存在,未被刪除。 |
| 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. | 操作失敗,無效的參數。 |
| 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. | 客戶您好,該地域已裁撤。 |
| 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服務失敗,請求處理失敗。 |
| 403 | IncorrectDBInstanceState | Current DB instance state does not support this operation. | 操作失敗,當前執行個體狀態不支援該操作,請稍後重試。 |
| 403 | InvalidConnVPCId | Specified conn vpc id is not valid. | 指定的連線專有網路ID無效。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正確或為空。 |
| 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 | 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 | IncorrectDBInstanceLockMode | Current DB instance lock mode does not support this operation. | 操作失敗,執行個體處於鎖定狀態。 |
| 404 | InvalidConnectionString.NotFound | Specified connection string or net type is not found. | 連線字串不存在。請檢查連線字串是否正確。 |
| 404 | InvalidConnectionString.Duplicate | Specified connection string already exists in the Aliyun RDS. | 連結位址名稱重複,請重新設定連接字串。 |
| 404 | InvalidWeight.Format | The Specified Weight format is not valid. | 無效的權重範圍。 |
| 404 | InvalidDBInstance.NotFound | Specified instance does not exist or not support. | 指定的執行個體不存在或不支援此操作。 |
| 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. | 指定的主機資訊不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。