為Redis集群實例申請直連地址。
接口說明
客戶端可通過直連地址繞過代理，像連接原生 Redis 集群一樣連接阿里云 Redis 集群，從而降低鏈路開銷，進一步提升 Redis 服務的響應速度。更多詳情請參見開通直連訪問。
調用本接口的 Redis 實例需滿足下述條件：
- Redis 實例為集群架構。
- 部署模式為經典。
- Redis 實例的網絡類型為專有網絡。如果當前為經典網絡，您可以調用 SwitchNetwork 接口將其切換為專有網絡。
- Redis 實例的 SSL 加密功能需處于關閉狀態。如果已開啟 SSL 加密功能，您可以調用 ModifyInstanceSSL 接口將其關閉。
- Redis 實例所屬的交換機需具備充足的可分配的 IP 地址數，詳情請參見查詢 Redis 實例所屬交換機可分配的 IP 地址數。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| kvstore:AllocateDirectConnection | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實例 ID。 | r-bp1zxszhcgatnx**** |
| ConnectionString | string | 否 | 直連地址的前綴，由小寫英文字母或數字組成，以小寫字母開頭，長度為 8~40 字符。默認為實例 ID+ | redisdirect123 |
| Port | string | 否 | 端口號，取值范圍為 1024~65535，默認值為 6379。 | 6379 |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | NetTypeExists | Specified net type already existed | - |
| 400 | InvalidConnType | Specified DB instance conn type is not valid. | - |
| 400 | TaskHasExist | The task already exists. | 任務已經存在，請稍后重試 |
| 400 | ConnectionStringAlreadyExists | Specified connection string already exists in the Aliyun RDS. | - |
| 400 | InvalidConnectionString.Format | Specified connection string is not valid. | 連接串非法，請選用新的 |
| 400 | DirectConnectionAlreadyExists | Specified instance direct connection already exists. | - |
| 400 | InvalidVPCParamGroup | Specified vpc param group is not valid. | - |
| 400 | InvalidConnectionString | ConnectionString is invalid, valid regex: ^\w+$ | 連接地址前綴非法，由小寫英文字母或數字組成，以小寫字母開頭，長度為8~40字符。 |
| 403 | UnsupportedEngineVersion | Current engine version does not support operations. | - |
| 403 | IncorrectMinorVersion | Current engine minor version does not support operations. | 當前實例小版本號不支持，請升級到最新小版本后重試 |
| 403 | InstanceStatus.NotSupport | Instance status does not support this operation. | 當前實例狀態不支持此操作 |
| 404 | InvalidDbInstanceId.NotFound | Specified instance does not exist. | 指定的實例不存在 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史