您可以通过调用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 错误码发生变更 | 查看变更详情 |