文档

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
DNSServiceRulesarray

DNS授权规则列表。

object

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参数非法

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