您可以通過調用ResolveAndRouteServiceInCen接口設置云服務,為本地網絡添加訪問云服務的配置。
接口說明
云服務指使用阿里云云服務地址段 100.64.0.0/10 提供服務的云產品,例如對象存儲 OSS(Object Storage Service)、日志服務 SLS(Log Service)、數據傳輸服務 DTS(Data Transmission Service)等。如果您的本地網絡需要訪問云服務,您需要將本地網絡關聯的邊界路由器 VBR(Virtual Border Router)實例或云連接網 CCN(Cloud Connect Network)實例加載至云企業網,并且將云服務所在地域的一個專有網絡 VPC(Virtual Private Cloud)實例加載至該云企業網。加載后,您的本地網絡可通過云企業網訪問云服務所在地域的 VPC 實例,并通過該 VPC 訪問云服務。
-
使用限制,該接口僅適用于基礎版轉發路由器。VBR 實例關聯的本地網絡只能通過云企業網訪問和其同地域的云服務。
例如:云服務所在地域為華北 2(北京),那么只有華北 2(北京)地域下的 VBR 實例關聯的本地網絡可以訪問云服務。
-
ResolveAndRouteServiceInCen 接口屬于異步接口,即系統會先返回一個 RequestId,但云服務配置并未添加完成,系統后臺的添加任務仍在進行。您可以調用 DescribeRouteServicesInCen 接口查詢云服務的狀態。
- 當云服務處于 Creating 狀態時,表示云服務配置正在添加中,在該狀態下,您只能對云服務配置執行查詢操作,不能執行其他操作。
- 當云服務處于 Active 狀態時,表示云服務配置添加完成。
- 當云服務處于 Failed 狀態時,表示云服務配置添加失敗。
前提條件
在調用 ResolveAndRouteServiceInCen 接口前,確保滿足以下條件:
- 您本地網絡連接的 VBR 或 CCN 實例已經加載到云企業網。
- 云服務所在地域已有 VPC 實例加載至云企業網。具體操作,請參見 AttachCenChildInstance 。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:ResolveAndRouteServiceInCen | create |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 02fb3da4**** |
CenId | string | 是 | 云企業網實例 ID。 | cen-ckwa2hhmuislse**** |
Host | string | 是 | 云服務 IP 地址或地址段。 說明
通常云服務會使用多個地址或地址段,建議您重復調用本接口,添加該云服務所有地址或地址段。
| 100.118.28.0/24 |
HostRegionId | string | 是 | 云服務所在的地域 ID。 | cn-hangzhou |
HostVpcId | string | 是 | 云服務關聯的 VPC 實例 ID。 | vpc-o6woh5s494zueq40v**** |
Description | string | 否 | 云服務的描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | descname |
AccessRegionIds | array | 是 | 訪問云服務的地域 ID 列表。 | |
string | 是 | 訪問云服務的地域 ID。 您可以通過調用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "C0245BEF-52AC-44A8-A776-EF96FD26A5CA"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ParameterIllegal.Ipv6CloudRouteCidrNotAllow | Parameter Host not in valid ipv6 cidr. | 云服務路由不支持ipv6。 |
400 | ParameterIllegal.AccessRegionId | Parameter Access RegionId illegal. | 參數中指定的AccessRegionId不合法。 |
400 | ParameterIllegal.CloudRouteHost | Parameter Host is not valid. | 參數中指定的CloudRouteHost不合法。 |
400 | ParameterIllegal.ClouteRouteNotSupportIpv6 | Parameter Host not support IPv6 | 云服務路由不支持ipv6。 |
400 | ParameterIllegal.ClouteRouteCidrNotAllow | Parameter Host not in 100.64.0.0/10 | 云服務路由網段不合法。 |
400 | CloudRoute.Exist | The Specified Cloud Route already Exists | 云服務路由已存在。 |
400 | ParameterIllegal.Host | Parameter Host does not support domain. | - |
400 | CloudRoute.Conflict | The Specified Cloud Route Conflicts. | 云服務路由沖突。 |
400 | CloudRoute.VpcNotAttached | The Specified Vpc instance is not attached to CEN. | 指定的VPC沒有綁定到CEN上。 |
400 | OperationUnsupported.TransitRouterType | The specified TransitRouterType does not support the operation. | 當前TransitRouter類型不支持該操作。 |
400 | ParameterIllegal.AccessRegionIdNoCCN | Parameter Access RegionId illegal. | 參數中指定的AccessRegionId不合法。 |
400 | IncorrectStatus.TransitRouter | The resource is not in a valid state for the operation. | 當前TR的狀態不支持該操作,請稍后重試。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2022-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |