文档

RoutePrivateZoneInCenToVpc - 设置PrivateZone

更新时间:

调用RoutePrivateZoneInCenToVpc接口设置PrivateZone服务。

接口说明

PrivateZone 是基于阿里云专有网络 VPC(Virtual Private Cloud)环境的私有 DNS 域名解析和管理服务。边界路由器 VBR(Virtual Border Router)实例、云连接网 CCN(Cloud Connect Network)实例加载到云企业网中后,其关联的本地网络可以通过云企业网访问 PrivateZone 服务。

  • VBR 实例和 CCN 实例关联的本地网络只能访问和其同地域的 PrivateZone 服务。

    例如:PrivateZone 服务所在地为华北 2(北京),那么只有华北 2(北京)地域下的 VBR 实例和中国内地 CCN 实例关联的本地网络可以访问 PrivateZone 服务。

  • RoutePrivateZoneInCenToVpc 接口属于异步接口,即系统会先返回一个 RequestId,但 PrivateZone 服务配置并未添加完成,系统后台的添加任务仍在进行。您可以调用 DescribeCenPrivateZoneRoutes 接口查询 PrivateZone 服务的状态。

    • 当 PrivateZone 服务处于 Creating 状态时,表示 PrivateZone 服务配置正在添加中,在该状态下,您只能对 PrivateZone 服务配置执行查询操作,不能执行其他操作。
    • 当 PrivateZone 服务处于 Active 状态时,表示 PrivateZone 服务配置添加完成。
    • 当 PrivateZone 服务处于 Failed 状态时,表示 PrivateZone 服务配置添加失败。

前提条件

在调用 RoutePrivateZoneInCenToVpc 接口前,确保满足以下条件:

  • 您已部署好 PrivateZone 服务。具体操作,请参见云解析 PrivateZone 快速入门
  • 确保 PrivateZone 服务关联的 VPC 实例、访问所在地的 VBR 实例或 CCN 实例已加载至同一个云企业网实例。具体操作,请参见 AttachCenChildInstance
  • 如果您本地网络使用 CCN 实例接入阿里云,且 CCN 实例所属账号与 VPC 实例所属账号、云企业网实例所属账号不同,那么您需要先完成对 CCN 实例的授权。具体操作,请参见云连接网授权

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:RoutePrivateZoneInCenToVpcWrite
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

请求参数

名称类型必填描述示例值
CenIdstring

云企业网实例 ID。

cen-7qthudw0ll6jmc****
AccessRegionIdstring

访问 PrivateZone 服务的地域 ID。

访问所在地是指访问 PrivateZone 服务的地域。

您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。

cn-hangzhou
HostRegionIdstring

PrivateZone 服务所在的地域 ID。

cn-hangzhou
HostVpcIdstring

PrivateZone 服务关联的 VPC 实例 ID。

vpc-bp1h8vbrbcgohcju5****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

C0245BEF-52AC-44A8-A776-EF96FD26A5CA

示例

正常返回示例

JSON格式

{
  "RequestId": "C0245BEF-52AC-44A8-A776-EF96FD26A5CA"
}

错误码

HTTP status code错误码错误信息描述
400OperationUnsupported.CrossRegionNotSupportOperation 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服务。
400Forbidden.PrivatezoneServiceNotAuthorizePrivatezone service not to grant authorization.Privatezone 服务未授权。
400ParameterIllegal.AccessRegionIdNoCCN Parameter Access RegionId illegal.-
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。
403InvalidOperation.PvtzNotAssociatedWithVpcPrivatezone not associated with the specified vpc.Privatezone没有绑定指定的vpc。
409InvalidOperation.PrivatezoneRouteExistedPrivatezone routes already existed.Private zone路由已存在。
409InvalidOperation.VpcNotAttachedToCenVpc not attached to cen.该vpc没有绑定到cen中。
409InvalidOperation.UnmatchRouteInVpcRegionOperation Failed.Unmatch route in vpc region.vpc地域中的路由不匹配。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-12-22OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 409 变更
    删除错误码:403
  • 本页导读 (1)