设置访问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:RoutePrivateZoneInCenToVpc | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CenId | string | 是 | 云企业网实例ID。 | cen-7qthudw0ll6jmc**** |
AccessRegionId | string | 是 | cn-hangzhou | |
HostRegionId | string | 是 | PrivateZone服务所在的地域ID。 | cn-hangzhou |
HostVpcId | string | 是 | PrivateZone服务关联的VPC实例ID。 | vpc-bp1h8vbrbcgohcju5**** |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "C0245BEF-52AC-44A8-A776-EF96FD26A5CA\t"
}
错误码
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. | - |
400 | Forbidden.PrivatezoneServiceNotAuthorize | Privatezone service not to grant authorization. | Privatezone 服务未授权。 |
400 | ParameterIllegal.AccessRegionIdNoCCN | Parameter Access RegionId illegal. | - |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
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. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-12-22 | OpenAPI 错误码发生变更 | |||||||||
|