文档

ListDNSServiceRules - 查询DNS授权规则

更新时间:

查询DNS授权规则。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-1y6h8z7imd2yu4****
DNSServiceRuleIdsarray

DNS 授权规则 ID。

string

DNS 授权规则 ID。最多支持输入 20 个规则 ID。

ar-c1dk4jb73j5791****
ServiceTypestring

DNS 授权规则的目标类型。取值:

  • Normal:普通类型。

  • DNSRedirect:重定向类型,重定向类型指将当前 DNS 服务地址重定向至另一个地址。

Normal
Destinationarray

目标 DNS 授权规则 IP 地址。

string

重定向后的 DNS 服务地址。最多支持输入 20 个目标 IP 地址。

说明 ServiceType 参数取值为 DNSRedirect 时,该参数必选。
192.168.0.2
DNSServiceRuleStatusarray

DNS 授权规则的状态。

string

DNS 授权规则的状态。最多支持输入 20 个 DNS 授权规则状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

Created
DNSServiceRuleNamearray

DNS 授权规则名称。最多支持输入 20 个规则名称。

string

DNS 授权规则名称。最多支持输入 20 个规则名称。

长度为 2~128 个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

test
Sourcearray

源 DNS 授权规则 IP 地址。

string

源 DNS IP 地址。最多支持输入 20 个源 IP 地址。包括但不限于以下取值:

100.100.2.136100.100.2.137100.100.2.138114.114.114.1148.8.8.88.8.4.4223.5.5.5223.6.6.6221.5.88.88116.116.116.116221.228.15.2661.139.2.69218.6.200.139119.29.29.29218.2.2.2208.67.220.220208.67.222.222218.4.4.4

除以上默认的 DNS 授权规则的 IP,如有其他 DNS 授权规则的 IP 诉求,请提交工单,并在工单中附上需要申请的 DNS 授权规则的 IP。

100.100.2.138
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。取值:1~50。默认值:10

10
RegionIdstring

云连接器实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

请求 ID。

RequestIdstring

请求 ID。

4A63118E-B375-5718-8F03-30F6804E1DCD
TotalCountinteger

总列表条目数。

10
NextTokenstring

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsinteger

分批次查询时每次显示的条目数。

10
DNSServiceRulesobject []

DNS 授权规则列表。

IoTCloudConnectorIdstring

云连接器实例 ID。

iotcc-1y6h8z7imd2yu4****
ServiceTypestring

DNS 授权规则的目标类型。取值:

  • Normal:普通类型。

  • DNSRedirect:重定向类型,重定向类型指将当前 DNS 服务地址重定向至另一个地址。

Normal
Sourcestring

源 DNS IP 地址。包括但不限于以下取值:

100.100.2.136100.100.2.137100.100.2.138114.114.114.1148.8.8.88.8.4.4223.5.5.5223.6.6.6221.5.88.88116.116.116.116221.228.15.2661.139.2.69218.6.200.139119.29.29.29218.2.2.2208.67.220.220208.67.222.222218.4.4.4

除以上默认的 DNS 授权规则的 IP,如有其他 DNS 授权规则的 IP 诉求,请提交工单,并在工单中附上需要申请的 DNS 授权规则的 IP。

100.100.2.138
Destinationstring

重定向后的 DNS 服务地址。

说明 ServiceType 参数取值为 DNSRedirect 时,该参数必选。
192.168.0.2
DNSServiceRuleStatusstring

DNS 授权规则的状态。取值:

  • Creating:创建中。

  • Created:创建完成。

  • Deleting:删除中。

  • Updating:更新中。

Created
DNSServiceRuleNamestring

DNS 授权规则名称。

长度为 2~128 个英文或中文字符,开头必须为大小写英文字母或中文,可包含数字、半角句号(.)、下划线(_)和短划线(-)。

test
DNSServiceRuleDescriptionstring

DNS 授权规则描述。

长度为 2~256 个字符,开头必须为大小写英文字母或中文,但不能为http://https://

description
DNSServiceRuleIdstring

DNS 授权规则 ID。

ar-c1dk4jb73j5791****

示例

正常返回示例

JSON格式

{
  "RequestId": "4A63118E-B375-5718-8F03-30F6804E1DCD",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 10,
  "DNSServiceRules": [
    {
      "IoTCloudConnectorId": "iotcc-1y6h8z7imd2yu4****",
      "ServiceType": "Normal",
      "Source": "100.100.2.138",
      "Destination": "192.168.0.2",
      "DNSServiceRuleStatus": "Created",
      "DNSServiceRuleName": "test",
      "DNSServiceRuleDescription": "description",
      "DNSServiceRuleId": "ar-c1dk4jb73j5791****"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400Forbidden.RAMRam user does not have permission to perform this operation.RAM用户无权限执行此操作。
400ResourceNotFound.IoTCloudConnectorThe param of IoTCloudConnectorId is illegal.IoTCloudConnectorId参数非法

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈