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

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

最近更新时间:2019-05-09 21:59:33

1. 接口描述

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

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

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

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:vpc.ap-shanghai-fsi.tencentcloudapi.com。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeIp6Translators
Version String 公共参数,本接口取值:2017-03-12
Region String 公共参数,详见产品支持的 地域列表
Ip6TranslatorIds.N Array of String IPV6转换实例唯一ID数组,形如ip6-xxxxxxxx
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 简介中的相关小节。
    Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合过滤条件的IPV6转换实例数量。
    Ip6TranslatorSet Array of Ip6Translator 符合过滤条件的IPV6转换实例详细信息
    RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

    4. 示例

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

    指定IPV6转换实例查询

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeIp6Translators
    &Ip6TranslatorId.0=ip6-90pt7p9q
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 3,
        "Ip6TranslatorSet": [
          {
            "Ip6TranslatorId": "ip6-ml2hm2dg",
            "Ip6TranslatorName": "未命名",
            "Vip6": null,
            "IspName": "",
            "TranslatorStatus": "CREATING",
            "CreatedTime": "2019-01-10T06:05:37Z",
            "Ip6RuleCount": 0,
            "Ip6RuleSet": []
          },
          {
            "Ip6TranslatorId": "ip6-90pt7p9q",
            "Ip6TranslatorName": "kkkk",
            "Vip6": "2402:4e00:20:100::2:1011",
            "IspName": "",
            "TranslatorStatus": "RUNNING",
            "CreatedTime": "2019-01-10T01:33:32Z",
            "Ip6RuleCount": 5,
            "Ip6RuleSet": [
              {
                "Ip6RuleId": "rule6-c1rvcaoa",
                "Ip6RuleName": "未命名",
                "Vip6": "2402:4e00:20:100::2:1011",
                "Vport6": 0,
                "Protocol": "tcp",
                "Vip": "",
                "Vport": 0,
                "RuleStatus": "CREATING",
                "CreatedTime": "2019-01-10T04:26:38Z"
              },
              {
                "Ip6RuleId": "rule6-r92oxfhm",
                "Ip6RuleName": "未命名",
                "Vip6": "2402:4e00:20:100::2:1011",
                "Vport6": 1,
                "Protocol": "tcp",
                "Vip": "100.100.1.1",
                "Vport": 2,
                "RuleStatus": "RUNNING",
                "CreatedTime": "2019-01-10T07:59:02Z"
              },
              {
                "Ip6RuleId": "rule6-kxlgqufa",
                "Ip6RuleName": "未命名",
                "Vip6": "2402:4e00:20:100::2:1011",
                "Vport6": 0,
                "Protocol": "tcp",
                "Vip": "",
                "Vport": 0,
                "RuleStatus": "CREATING",
                "CreatedTime": "2019-01-10T07:59:02Z"
              },
              {
                "Ip6RuleId": "rule6-k5l5hnwk",
                "Ip6RuleName": "未命名",
                "Vip6": "2402:4e00:20:100::2:1011",
                "Vport6": 0,
                "Protocol": "tcp",
                "Vip": "",
                "Vport": 0,
                "RuleStatus": "CREATING",
                "CreatedTime": "2019-01-10T08:12:27Z"
              },
              {
                "Ip6RuleId": "rule6-7v3vwgec",
                "Ip6RuleName": "未命名",
                "Vip6": "2402:4e00:20:100::2:1011",
                "Vport6": 0,
                "Protocol": "tcp",
                "Vip": "",
                "Vport": 0,
                "RuleStatus": "CREATING",
                "CreatedTime": "2019-01-10T08:12:27Z"
              }
            ]
          },
          {
            "Ip6TranslatorId": "ip6-8svxwtts",
            "Ip6TranslatorName": "未命名",
            "Vip6": null,
            "IspName": "",
            "TranslatorStatus": "CREATING",
            "CreatedTime": "2019-01-09T13:50:06Z",
            "Ip6RuleCount": 0,
            "Ip6RuleSet": []
          }
        ],
        "RequestId": "fb44e0a1-1827-4d3d-abde-9514e884dbeb"
      }
    }

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

    指定Filters查询IPV6转换实例

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeIp6Translators
    &Filters.0.Name=ip6-translator-uid
    &Filters.0.Values=ip6-8svxwtts
    &<公共请求参数>

    输出示例

    {
      "Response": {
        "TotalCount": 1,
        "Ip6TranslatorSet": [
          {
            "Ip6TranslatorId": "ip6-8svxwtts",
            "Ip6TranslatorName": "未命名",
            "Vip6": null,
            "IspName": "",
            "TranslatorStatus": "CREATING",
            "CreatedTime": "2019-01-09T13:50:06Z",
            "Ip6RuleCount": 0,
            "Ip6RuleSet": []
          }
        ],
        "RequestId": "cbf8a954-d135-4b52-9935-89e9ec88b536"
      }
    }

    5. 开发者资源

    API Explorer

    该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

    SDK

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

    命令行工具

    6. 错误码

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

    错误码 描述
    InternalServerError 操作内部错误。
    InvalidParameter 入参不合法。