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

最近更新时间: 2024-09-03 18:49:49

1. 接口描述

接口请求域名: vpc.api3.cloud.sunhongs.com。

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

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

接口更新时间:2019-01-23 15:59:19。

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码 描述
InvalidParameter
InternalServerError