文档中心>私有网络>API 文档>云联网相关接口>替换云联网路由传播策略

替换云联网路由传播策略

最近更新时间:2024-10-15 01:31:45

我的收藏

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(ReplaceCcnRouteTableBroadcastPolicys)用于替换云联网路由表路由传播策略。

特别注意:是全量覆盖,非增量添加

路由条件支持以下四种:

  • 实例类型: instance-type,可选值:私有网络 VPC、专线网关 DIRECTCONNECT、VPN网关 VPNGW
  • 实例ID: instance-id,例如:dcg-8zljkrftvpc-jdevjrup,暂不支持 Edge 实例
  • 实例地域: instance-region,例如:ap-guangzhou
    产品支持的所有地域列表可通过接口 DescribeRegions 查询,其中参数 Product 设置为 ccn
  • 路由前缀: cidr-block,例如:10.1.0.0/16

传播条件支持以下三种:

  • 实例类型: instance-type,格式同路由条件
  • 实例ID: instance-id,格式同路由条件
  • 实例地域: instance-region,格式同路由条件

使用限制:

  • 一条策略内的单个条件类型,最大支持设置 25 个条件值
  • 一张路由表,最大支持 100 条路由传播策略
  • 路由条件类型中,只有 cidr-block 类型支持模糊匹配和精确匹配两种,其它类型只支持精确匹配一种模式

默认接口请求频率限制:2次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ReplaceCcnRouteTableBroadcastPolicys。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
CcnId String 云联网ID
示例值:ccn-qd6z2ld1
RouteTableId String 云联网路由表ID
示例值:ccnrtb-1mkezrkd
Policys.N Array of CcnRouteTableBroadcastPolicy 新的路由传播策略

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 替换云联网路由传播策略

替换云联网路由传播策略

输入示例

POST / HTTP/1.1
Host: vpc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ReplaceCcnRouteTableBroadcastPolicys
<公共请求参数>

{
    "CcnId": "ccn-qd6z2ld1",
    "RouteTableId": "ccnrtb-1mkezrkd",
    "Policys": [
        {
            "RouteConditions": [
                {
                    "Name": "instance-type",
                    "Values": [
                        "VPC",
                        "DIRECTCONNECT"
                    ],
                    "MatchPattern": 1
                },
                {
                    "Name": "instance-id",
                    "Values": [
                        "dcg-8zljkrft",
                        "vpc-jdevjrup"
                    ],
                    "MatchPattern": 1
                }
            ],
            "BroadcastConditions": [
                {
                    "Name": "instance-id",
                    "Values": [
                        "vpc-jdevjrup",
                        "vpc-hb81v349"
                    ],
                    "MatchPattern": 1
                }
            ],
            "Action": "accept",
            "Description": "指定vpc接收北京指定专线和vpc路由"
        },
        {
            "RouteConditions": [
                {
                    "Name": "instance-region",
                    "Values": [
                        "ap-beijing"
                    ],
                    "MatchPattern": 1
                },
                {
                    "Name": "instance-type",
                    "Values": [
                        "VPC",
                        "DIRECTCONNECT",
                        "VPNGW"
                    ],
                    "MatchPattern": 1
                },
                {
                    "Name": "cidr-block",
                    "Values": [
                        "9.0.0.0/8",
                        "10.0.0.0/8",
                        "192.168.0.0/24"
                    ],
                    "MatchPattern": 1
                }
            ],
            "BroadcastConditions": [
                {
                    "Name": "instance-region",
                    "Values": [
                        "ap-beijing"
                    ],
                    "MatchPattern": 1
                },
                {
                    "Name": "instance-id",
                    "Values": [
                        "vpc-jdevjrup",
                        "vpc-hb81v349"
                    ],
                    "MatchPattern": 1
                }
            ],
            "Action": "drop",
            "Description": "指定VPC绝收北京地域专线、VPC、VPN三大网段"
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "6fe64d7f-3983-4f17-847d-a60dded41951"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InvalidParameter.InvalidKey 指定参数值不是预期的字典格式。
InvalidParameter.NotDict 指定参数值不是键值对。
InvalidParameter.NotList 指定参数值不是一个列表。
InvalidParameter.NotStr 指定键值不是一个字符串型。
InvalidParameterValue.ParameterMismatch 参数值格式不匹配。
LimitExceeded.CcnRouteBroadcastPolicy 云联网路由传播策略数量已达到上限。
LimitExceeded.CcnRouteBroadcastPolicyCond 云联网路由传播策略条件数量已达到上限。
UnsupportedOperation.BroadcastConditionMustBeVpgTypeOrVpgInstance 添加 community 时,传播条件只支持 vpg 类型或 vpg 实例
UnsupportedOperation.CcnNotEnableBroadcastPolicy 当前云联网未开启路由传播策略。
UnsupportedOperation.CcnNotEnableCommunity 添加 community 时,vpg 需要开通传播 community 白名单