調(diào)用RoutePrivateZoneInCenToVpc接口設(shè)置PrivateZone服務(wù)。
接口說明
PrivateZone 是基于阿里云專有網(wǎng)絡(luò) VPC(Virtual Private Cloud)環(huán)境的私有 DNS 域名解析和管理服務(wù)。邊界路由器 VBR(Virtual Border Router)實例、云連接網(wǎng) CCN(Cloud Connect Network)實例加載到云企業(yè)網(wǎng)中后,其關(guān)聯(lián)的本地網(wǎng)絡(luò)可以通過云企業(yè)網(wǎng)訪問 PrivateZone 服務(wù)。
-
VBR 實例和 CCN 實例關(guān)聯(lián)的本地網(wǎng)絡(luò)只能訪問和其同地域的 PrivateZone 服務(wù)。
例如:PrivateZone 服務(wù)所在地為華北 2(北京),那么只有華北 2(北京)地域下的 VBR 實例和中國內(nèi)地 CCN 實例關(guān)聯(lián)的本地網(wǎng)絡(luò)可以訪問 PrivateZone 服務(wù)。
-
RoutePrivateZoneInCenToVpc 接口屬于異步接口,即系統(tǒng)會先返回一個 RequestId,但 PrivateZone 服務(wù)配置并未添加完成,系統(tǒng)后臺的添加任務(wù)仍在進行。您可以調(diào)用 DescribeCenPrivateZoneRoutes 接口查詢 PrivateZone 服務(wù)的狀態(tài)。
- 當(dāng) PrivateZone 服務(wù)處于 Creating 狀態(tài)時,表示 PrivateZone 服務(wù)配置正在添加中,在該狀態(tài)下,您只能對 PrivateZone 服務(wù)配置執(zhí)行查詢操作,不能執(zhí)行其他操作。
- 當(dāng) PrivateZone 服務(wù)處于 Active 狀態(tài)時,表示 PrivateZone 服務(wù)配置添加完成。
- 當(dāng) PrivateZone 服務(wù)處于 Failed 狀態(tài)時,表示 PrivateZone 服務(wù)配置添加失敗。
前提條件
在調(diào)用 RoutePrivateZoneInCenToVpc 接口前,確保滿足以下條件:
- 您已部署好 PrivateZone 服務(wù)。具體操作,請參見云解析 PrivateZone 快速入門。
- 確保 PrivateZone 服務(wù)關(guān)聯(lián)的 VPC 實例、訪問所在地的 VBR 實例或 CCN 實例已加載至同一個云企業(yè)網(wǎng)實例。具體操作,請參見 AttachCenChildInstance 。
- 如果您本地網(wǎng)絡(luò)使用 CCN 實例接入阿里云,且 CCN 實例所屬賬號與 VPC 實例所屬賬號、云企業(yè)網(wǎng)實例所屬賬號不同,那么您需要先完成對 CCN 實例的授權(quán)。具體操作,請參見云連接網(wǎng)授權(quán)。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cen:RoutePrivateZoneInCenToVpc | create |
|
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CenId | string | 是 | 云企業(yè)網(wǎng)實例 ID。 | cen-7qthudw0ll6jmc**** |
AccessRegionId | string | 是 | 訪問 PrivateZone 服務(wù)的地域 ID。 訪問所在地是指訪問 PrivateZone 服務(wù)的地域。 您可以通過調(diào)用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
HostRegionId | string | 是 | PrivateZone 服務(wù)所在的地域 ID。 | cn-hangzhou |
HostVpcId | string | 是 | PrivateZone 服務(wù)關(guān)聯(lián)的 VPC 實例 ID。 | vpc-bp1h8vbrbcgohcju5**** |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "C0245BEF-52AC-44A8-A776-EF96FD26A5CA"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | OperationUnsupported.CrossRegionNotSupport | Operation Failed. Host region Id is not equal to access region Id, VPC or VBR not support cross region privatezone service. | 主機地域ID與接入地域ID不一致,VPC或VBR不支持跨地域PrivateZone服務(wù)。 |
400 | Forbidden.PrivatezoneServiceNotAuthorize | Privatezone service not to grant authorization. | Privatezone 服務(wù)未授權(quán)。 |
400 | ParameterIllegal.AccessRegionIdNoCCN | Parameter Access RegionId illegal. | - |
400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權(quán)限操作。 |
403 | InvalidOperation.PvtzNotAssociatedWithVpc | Privatezone not associated with the specified vpc. | Privatezone沒有綁定指定的vpc。 |
409 | InvalidOperation.PrivatezoneRouteExisted | Privatezone routes already existed. | Private zone路由已存在。 |
409 | InvalidOperation.VpcNotAttachedToCen | Vpc not attached to cen. | 該vpc沒有綁定到cen中。 |
409 | InvalidOperation.UnmatchRouteInVpcRegion | Operation Failed.Unmatch route in vpc region. | vpc地域中的路由不匹配。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2022-12-22 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |