文档中心>API 中心>私有网络>IPV6转换服务相关接口>查询IPV6转换实例及其绑定规则信息

查询IPV6转换实例及其绑定规则信息

最近更新时间:2025-04-25 02:11:15

我的收藏

1. 接口描述

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

  1. 该接口用于查询账户下的IPV6转换实例及其绑定的转换规则信息
  2. 支持过滤查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIp6Translators。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Ip6TranslatorIds.N Array of String IPV6转换实例唯一ID数组,形如ip6-xxxxxxxx
示例值:ip6-pfkw84ug
Filters.N Array of Filter 每次请求的Filters的上限为10,Filter.Values的上限为5。参数不支持同时指定Ip6TranslatorIdsFilters。详细的过滤条件如下:
  • ip6-translator-id - String - 是否必填:否 - (过滤条件)按照IPV6转换实例的唯一ID过滤,形如ip6-xxxxxxx。
  • ip6-translator-vip6 - String - 是否必填:否 - (过滤条件)按照IPV6地址过滤。不支持模糊过滤。
  • ip6-translator-name - String - 是否必填:否 - (过滤条件)按照IPV6转换实例名称过滤。不支持模糊过滤。
  • ip6-translator-status - String - 是否必填:否 - (过滤条件)按照IPV6转换实例的状态过滤。状态取值范围为"CREATING","RUNNING","DELETING","MODIFYING"。
  • Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
    示例值:0
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
    示例值:20

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的IPV6转换实例数量。
    示例值:1
    Ip6TranslatorSet Array of Ip6Translator 符合过滤条件的IPV6转换实例详细信息
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 指定IPV6转换实例查询

    指定IPV6转换实例查询

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeIp6Translators
    <公共请求参数>
    
    {
        "Ip6TranslatorIds": [
            "ip6-mhnrv51i"
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "Ip6TranslatorSet": [
                {
                    "Ip6TranslatorId": "ip6-mhnrv51i",
                    "Ip6TranslatorName": "ukiotest1",
                    "Vip6": "2402:4e00:40:40::2:2a6",
                    "IspName": "BGP",
                    "TranslatorStatus": "RUNNING",
                    "CreatedTime": "2023-07-13T11:12:06Z",
                    "Ip6RuleCount": 1,
                    "IP6RuleSet": [
                        {
                            "Ip6RuleId": "rule6-ganlwp48",
                            "Ip6RuleName": "未命名",
                            "Vip6": "2402:4e00:40:40::2:2a6",
                            "Vport6": 80,
                            "Protocol": "TCP",
                            "Vip": "10.0.0.0",
                            "Vport": 80,
                            "RuleStatus": "RUNNING",
                            "CreatedTime": "2023-07-26T02:27:16Z"
                        }
                    ]
                }
            ],
            "RequestId": "c5ad87da-28fb-4f5d-8fce-bf19a06cfe6d"
        }
    }

    示例2 指定Filters查询IPV6转换实例

    指定Filters查询IPV6转换实例

    输入示例

    POST / HTTP/1.1
    Host: vpc.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DescribeIp6Translators
    <公共请求参数>
    
    {
        "Filters": [
            {
                "Name": "ip6-translator-vip6",
                "Values": [
                    "2402:4e00:40:40::2:2a6"
                ]
            }
        ]
    }

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "Ip6TranslatorSet": [
                {
                    "Ip6TranslatorId": "ip6-mhnrv51i",
                    "Ip6TranslatorName": "ukiotest1",
                    "Vip6": "2402:4e00:40:40::2:2a6",
                    "IspName": "BGP",
                    "TranslatorStatus": "RUNNING",
                    "CreatedTime": "2023-07-13T11:12:06Z",
                    "Ip6RuleCount": 1,
                    "IP6RuleSet": [
                        {
                            "Ip6RuleId": "rule6-ganlwp48",
                            "Ip6RuleName": "未命名",
                            "Vip6": "2402:4e00:40:40::2:2a6",
                            "Vport6": 80,
                            "Protocol": "TCP",
                            "Vip": "10.0.0.0",
                            "Vport": 80,
                            "RuleStatus": "RUNNING",
                            "CreatedTime": "2023-07-26T02:27:16Z"
                        }
                    ]
                }
            ],
            "RequestId": "c5ad87da-28fb-4f5d-8fce-bf19a06cfe6d"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

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

    API Inspector

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

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidParameter 参数错误。