{ "name": "dnspod", "display_name": "DNSPod", "description": "欢迎使用 DNSPod 。 DNSPod ，又称为 DNS 解析、云解析，为用户提供快速、稳定且高可用的 DNS 服务，支持智能解析、流量调度、安全防护。 DNSPod 为腾讯云旗下品牌，专注于域名及 DNS 服务。DNSPod 持续提供了 17 年不间断服务，已服务 800 万+用户，累计 2000 万+域名，拥有 48 个全球集群节点，始终坚持为用户提供安全、稳定且快速的服务。国民级 DNS 服务平台，更值得信赖。", "domain": "network", "api_version": "2021-03-23", "endpoint": "dnspod.tencentcloudapi.com", "actions": [ { "name": "CheckRecordSnapshotRollback", "description": "回滚前检查单条记录", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照记录 ID", "example": "BCED853D" }, { "name": "Record", "type": "object", "required": true, "description": "解析记录信息", "example": "无", "children": [ { "name": "SubDomain", "type": "string", "required": true, "description": "子域名", "example": "www" }, { "name": "RecordType", "type": "string", "required": true, "description": "记录类型", "example": "A" }, { "name": "RecordLine", "type": "string", "required": true, "description": "解析线路", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "解析值", "example": "0.0.0.0" }, { "name": "TTL", "type": "string", "required": true, "description": "TTL(秒)", "example": "600" }, { "name": "RecordId", "type": "string", "required": false, "description": "解析记录 ID", "example": "15689601" }, { "name": "MX", "type": "string", "required": false, "description": "MX优先级注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Weight", "type": "string", "required": false, "description": "权重注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "Reason", "type": "string", "required": false, "description": "失败原因注意：此字段可能返回 null，表示取不到有效值。", "example": "线路不存在" } ] }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain", "SnapshotId", "Record" ] }, { "name": "CheckSnapshotRollback", "description": "快照回滚前检查", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照记录 ID", "example": "EG34GE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain", "SnapshotId" ] }, { "name": "CreateDeal", "description": "DNSPod商品下单", "status": "online", "parameters": [ { "name": "DealType", "type": "integer", "required": true, "description": "询价类型，1 新购，2 续费，3 套餐升级（增值服务暂时只支持新购）", "example": "1" }, { "name": "GoodsType", "type": "integer", "required": true, "description": "商品类型，1 域名套餐 2 增值服务", "example": "1" }, { "name": "GoodsChildType", "type": "string", "required": true, "description": "套餐类型： DP_PLUS：专业版 DP_EXPERT：企业版 DP_ULTRA：尊享版增值服务类型 LB：负载均衡 URL：URL转发 DMONITOR_TASKS：D监控任务数 DMONITOR_IP：D监控备用 IP 数 CUSTOMLINE：自定义线路数", "example": "DP_PLUS" }, { "name": "GoodsNum", "type": "integer", "required": true, "description": "增值服务购买数量，如果是域名套餐固定为1，如果是增值服务则按以下规则：负载均衡、D监控任务数、D监控备用 IP 数、自定义线路数、URL 转发（必须是5的正整数倍，如 5、10、15 等）", "example": "1" }, { "name": "AutoRenew", "type": "integer", "required": true, "description": "是否开启自动续费，1 开启，2 不开启（增值服务暂不支持自动续费），默认值为 2 不开启", "example": "1" }, { "name": "Domain", "type": "string", "required": false, "description": "需要绑定套餐的域名，如 dnspod.cn，如果是续费或升级，domain 参数必须要传，新购可不传。", "example": "testses.com" }, { "name": "TimeSpan", "type": "integer", "required": false, "description": "套餐时长： 1. 套餐以月为单位（按月只能是 3、6 还有 12 的倍数），套餐例如购买一年则传12，最大120 。（续费最低一年） 2. 升级套餐时不需要传。 3. 增值服务的时长单位为年，买一年传1（增值服务新购按年只能是 1，增值服务续费最大为 10）", "example": "3" }, { "name": "NewPackageType", "type": "string", "required": false, "description": "套餐类型，需要升级到的套餐类型，只有升级时需要。", "example": "DP_EXTRA" } ], "required": [ "DealType", "GoodsType", "GoodsChildType", "GoodsNum", "AutoRenew" ] }, { "name": "CreateDomain", "description": "添加域名", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "GroupId", "type": "integer", "required": false, "description": "域名分组ID。可以通过接口DescribeDomainGroupList查看当前域名分组信息", "example": "2" }, { "name": "IsMark", "type": "string", "required": false, "description": "是否星标域名，\"yes\"、\"no\" 分别代表是和否。", "example": "no" }, { "name": "TransferSubDomain", "type": "boolean", "required": false, "description": "添加子域名时，是否迁移相关父域名的解析记录。不传默认为 true", "example": "true" }, { "name": "Tags", "type": "array", "required": false, "description": "域名绑定的标签", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "key1" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签值", "example": "value1" } ] } ], "required": [ "Domain" ] }, { "name": "CreateDomainAlias", "description": "创建域名别名", "status": "online", "parameters": [ { "name": "DomainAlias", "type": "string", "required": true, "description": "域名别名", "example": "cc.cc" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "myfm.cc" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "145521" } ], "required": [ "DomainAlias", "Domain" ] }, { "name": "CreateDomainBatch", "description": "批量添加域名", "status": "online", "parameters": [ { "name": "DomainList", "type": "array", "required": true, "description": "域名数组", "example": "[\"dnspod1.cn\",\"dnspod2.cn\"]", "item_type": "string" }, { "name": "RecordValue", "type": "string", "required": false, "description": "每个域名添加 @ 和 www 的 A 记录值，记录值为IP，如果不传此参数或者传空，将只添加域名，不添加记录。", "example": "11.22.33.44" } ], "required": [ "DomainList" ] }, { "name": "CreateDomainCustomLine", "description": "创建域名的自定义线路", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Name", "type": "string", "required": true, "description": "自定义线路名称", "example": "testline8" }, { "name": "Area", "type": "string", "required": true, "description": "自定义线路IP段，用-分割", "example": "6.6.6.1-6.6.6.3" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Domain", "Name", "Area" ] }, { "name": "CreateDomainGroup", "description": "创建域名分组", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "域名分组", "example": "常用域名" } ], "required": [ "GroupName" ] }, { "name": "CreateDomainsAnalyticsFile", "description": "批量导出域名解析量", "status": "online", "parameters": [ { "name": "Domains", "type": "array", "required": true, "description": "需要查询解析量的域名数组。", "example": "[\"dnspod.cn\",\"dnspod.com\"]", "item_type": "string" }, { "name": "StartDate", "type": "string", "required": true, "description": "查询解析量的时间区间起点。如：2023-01-01。", "example": "2023-01-01" }, { "name": "DNSFormat", "type": "string", "required": false, "description": "查询解析量的统计维度。默认为 DATE。 DATE：按天统计 HOUR：按小时统计", "example": "DATE" }, { "name": "EndDate", "type": "string", "required": false, "description": "查询解析量的时间区间终点。如：2023-01-01。默认为当天。", "example": "2023-01-02" } ], "required": [ "Domains", "StartDate" ] }, { "name": "CreateLineGroup", "description": "创建域名的线路分组", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "自定义线路分组的名称。", "example": "testgroup99" }, { "name": "Lines", "type": "string", "required": true, "description": "自定义线路分组包含的线路列表，包含多个线路时用英文逗号分隔。例如，铁通,奇虎", "example": "电信,移动" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Name", "Lines", "Domain" ] }, { "name": "CreateLineGroupCopy", "description": "复制域名的线路分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainIds", "type": "string", "required": true, "description": "要复制的域名ID。要从多个域名复制线路分组时，用英文逗号分隔，例如1002,1005", "example": "1002" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Domain", "DomainIds" ] }, { "name": "CreateRecord", "description": "添加记录备注：新添加的解析记录存在短暂的索引延迟，如果查询不到新增记录，请在 30 秒后重试", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordType", "type": "string", "required": true, "description": "记录类型，可通过接口DescribeRecordType获得，大写英文，比如：A 。", "example": "A" }, { "name": "RecordLine", "type": "string", "required": true, "description": "记录线路，可以通过接口DescribeRecordLineList查看当前域名允许的线路信息，中文，比如：默认。", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "记录值，如 IP : 200.200.200.200， CNAME : cname.dnspod.com.， MX : mail.dnspod.com.。", "example": "200.200.200.200" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1923" }, { "name": "SubDomain", "type": "string", "required": false, "description": "主机记录，如 www，如果不传，默认为 @。", "example": "admin" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "线路的 ID，可以通过接口DescribeRecordLineList查看当前域名允许的线路信息，英文字符串，比如：10=1。参数RecordLineId优先级高于RecordLine，如果同时传递二者，优先使用RecordLineId参数。", "example": "10=1" }, { "name": "MX", "type": "integer", "required": false, "description": "MX 优先级，当记录类型是 MX、HTTPS、SVCB 时必填，范围1-65535。", "example": "10" }, { "name": "TTL", "type": "integer", "required": false, "description": "TTL，范围1-604800，不同套餐域名最小值不同。", "example": "600" }, { "name": "Weight", "type": "integer", "required": false, "description": "权重信息，0到100的整数。0 表示关闭，不传该参数，表示不设置权重信息。", "example": "20" }, { "name": "Status", "type": "string", "required": false, "description": "记录初始状态，取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ，如果传入 DISABLE，解析不会生效，也不会验证负载均衡的限制。", "example": "ENABLE" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "官网主页" }, { "name": "DnssecConflictMode", "type": "string", "required": false, "description": "开启DNSSEC时，强制添加CNAME/URL记录", "example": "force" }, { "name": "GroupId", "type": "integer", "required": false, "description": "记录分组 Id。可以通过接口 DescribeRecordGroupList 接口 GroupId 字段获取。", "example": "54543" } ], "required": [ "Domain", "RecordType", "RecordLine", "Value" ] }, { "name": "CreateRecordBatch", "description": "批量添加记录", "status": "online", "parameters": [ { "name": "DomainIdList", "type": "array", "required": true, "description": "域名ID，多个域名ID用英文逗号进行分割。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "[\"49\",\"53\"]", "item_type": "string" }, { "name": "RecordList", "type": "array", "required": true, "description": "记录数组", "example": "无", "item_type": "object", "children": [ { "name": "RecordType", "type": "string", "required": true, "description": "记录类型, 详见 DescribeRecordType 接口。", "example": "A" }, { "name": "Value", "type": "string", "required": true, "description": "记录值。", "example": "129.23.32.32" }, { "name": "SubDomain", "type": "string", "required": false, "description": "子域名(主机记录)，默认为@。", "example": "www" }, { "name": "RecordLine", "type": "string", "required": false, "description": "解析记录的线路，详见 DescribeRecordLineList 接口，RecordLine和RecordLineId都未填时，默认为「默认」线路。", "example": "百度" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "解析记录的线路 ID，RecordLine和RecordLineId都有时，系统优先取 RecordLineId。", "example": "90=0" }, { "name": "MX", "type": "integer", "required": false, "description": "记录的 MX 记录值，非 MX 记录类型，默认为 0，MX记录则必选。", "example": "20" }, { "name": "TTL", "type": "integer", "required": false, "description": "记录的 TTL 值，默认600。", "example": "600" } ] } ], "required": [ "DomainIdList", "RecordList" ] }, { "name": "CreateRecordGroup", "description": "添加记录分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "GroupName", "type": "string", "required": true, "description": "分组名称", "example": "分组2" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain", "GroupName" ] }, { "name": "CreateSnapshot", "description": "创建快照", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain" ] }, { "name": "CreateSubDomainsAnalyticsFile", "description": "批量导出子域名解析量", "status": "online", "parameters": [ { "name": "Domains", "type": "array", "required": true, "description": "需要查询解析量的域名数组。", "example": "无", "item_type": "object", "children": [ { "name": "Domain", "type": "string", "required": true, "description": "要查询解析量的主域名。", "example": "dnspod.cn" }, { "name": "SubDomain", "type": "string", "required": false, "description": "要查询解析量的子域名主机头。", "example": "www" }, { "name": "Offset", "type": "integer", "required": false, "description": "查询子域名列表的偏移量。没有指定查询的 Subdomain 参数时，根据分页参数返回每页子域名解析量。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "查询子域名列表的每页条数。没有指定查询的 Subdomain 参数时，根据分页参数返回每页子域名解析量。", "example": "10" } ] }, { "name": "StartDate", "type": "string", "required": true, "description": "查询解析量的时间区间起点。如：2023-01-01。", "example": "2023-01-01" }, { "name": "SubDomainType", "type": "integer", "required": true, "description": "查询解析量子域名类型。 1：子域名 2：无解析量子域名", "example": "1" }, { "name": "DNSFormat", "type": "string", "required": false, "description": "查询解析量的统计维度。默认为 DATE。 DATE：按天统计 HOUR：按小时统计", "example": "DATE" }, { "name": "EndDate", "type": "string", "required": false, "description": "查询解析量的时间区间终点。如：2023-01-01。默认为当天。", "example": "2023-01-02" } ], "required": [ "Domains", "StartDate", "SubDomainType" ] }, { "name": "CreateSubdomainValidateTXTValue", "description": "创建添加子域名 Zone 域解析时所需要的 TXT 记录值", "status": "online", "parameters": [ { "name": "DomainZone", "type": "string", "required": true, "description": "要添加的子域名 Zone 域。", "example": "sub.dnspod.cn" } ], "required": [ "DomainZone" ] }, { "name": "CreateTXTRecord", "description": "添加TXT记录备注：新添加的解析记录存在短暂的索引延迟，如果查询不到新增记录，请在 30 秒后重试", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordLine", "type": "string", "required": true, "description": "记录线路", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "记录值，如 IP : 200.200.200.200， CNAME : cname.dnspod.com.， MX : mail.dnspod.com.。", "example": "200.200.200.200" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1923" }, { "name": "SubDomain", "type": "string", "required": false, "description": "主机记录，如 www，如果不传，默认为 @。", "example": "www" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "线路的 ID，英文字符串，比如：10=1。参数RecordLineId优先级高于RecordLine，如果同时传递二者，优先使用RecordLineId参数。", "example": "10=1" }, { "name": "TTL", "type": "integer", "required": false, "description": "TTL，范围1-604800，不同套餐域名最小值不同。", "example": "600" }, { "name": "Status", "type": "string", "required": false, "description": "记录初始状态，取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ，如果传入 DISABLE，解析不会生效，也不会验证负载均衡的限制。", "example": "ENABLE" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "官网主页" }, { "name": "GroupId", "type": "integer", "required": false, "description": "记录分组 Id。", "example": "3430" } ], "required": [ "Domain", "RecordLine", "Value" ] }, { "name": "DeleteDomain", "description": "删除域名", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "254142" } ], "required": [ "Domain" ] }, { "name": "DeleteDomainAlias", "description": "删除域名别名", "status": "online", "parameters": [ { "name": "DomainAliasId", "type": "integer", "required": true, "description": "域名别名ID。可以通过接口DescribeDomainAliasList查到所有的域名别名列表以及对应的ID", "example": "14564" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "myfm.cc" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "4324242" } ], "required": [ "DomainAliasId", "Domain" ] }, { "name": "DeleteDomainBatch", "description": "批量删除域名", "status": "online", "parameters": [ { "name": "DomainList", "type": "array", "required": true, "description": "域名数组", "example": "[\"domain.com\"]", "item_type": "string" } ], "required": [ "DomainList" ] }, { "name": "DeleteDomainCustomLine", "description": "删除域名的自定义线路", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Name", "type": "string", "required": true, "description": "自定义线路名称", "example": "testline8" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Domain", "Name" ] }, { "name": "DeleteLineGroup", "description": "删除域名的线路分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "LineGroupId", "type": "integer", "required": true, "description": "自定义线路分组ID", "example": "10" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Domain", "LineGroupId" ] }, { "name": "DeleteRecord", "description": "删除记录", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "162" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain", "RecordId" ] }, { "name": "DeleteRecordBatch", "description": "批量删除解析记录备注：因存储限制，建议一次批量删除最多2000条", "status": "online", "parameters": [ { "name": "RecordIdList", "type": "array", "required": true, "description": "解析记录 ID 数组", "example": "[111, 101]", "item_type": "integer" } ], "required": [ "RecordIdList" ] }, { "name": "DeleteRecordGroup", "description": "删除记录分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "GroupId", "type": "integer", "required": true, "description": "分组 ID，可通过DescribeRecordGroupList接口获取所有记录分组", "example": "145" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain", "GroupId" ] }, { "name": "DeleteShareDomain", "description": "按账号删除域名共享", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Account", "type": "string", "required": true, "description": "域名共享的账号", "example": "qcloud_uin_100000014227@qcloud.com" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" } ], "required": [ "Domain", "Account" ] }, { "name": "DeleteSnapshot", "description": "删除快照", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照 ID。可以通过接口DescribeSnapshotList查询快照 ID", "example": "EG34GE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain", "SnapshotId" ] }, { "name": "DescribeBatchTask", "description": "获取批量操作任务执行详情", "status": "online", "parameters": [ { "name": "JobId", "type": "integer", "required": true, "description": "任务ID。操作批量接口时会返回JobId", "example": "21" } ], "required": [ "JobId" ] }, { "name": "DescribeDomain", "description": "获取域名信息", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainAliasList", "description": "获取域名别名列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "myfm.cc" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID,域名ID，参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "134243" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainAnalytics", "description": "统计各个域名的解析量，帮助您了解流量情况、时间段分布。支持查看近 3 个月内的统计情况", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "要查询解析量的域名", "example": "example.com" }, { "name": "StartDate", "type": "string", "required": true, "description": "查询的开始时间，格式：YYYY-MM-DD", "example": "2022-06-08" }, { "name": "EndDate", "type": "string", "required": true, "description": "查询的结束时间，格式：YYYY-MM-DD", "example": "2022-06-14" }, { "name": "DnsFormat", "type": "string", "required": false, "description": "DATE:按天维度统计 HOUR:按小时维度统计", "example": "DATE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1143114" } ], "required": [ "Domain", "StartDate", "EndDate" ] }, { "name": "DescribeDomainAndRecordList", "description": "批量操作中搜索域名", "status": "online", "parameters": [ { "name": "AllDomain", "type": "string", "required": false, "description": "搜索所有域名。AllDomain、GroupIdList、DomainList、DomainIdList 参数传任一个即可。优先级为：AllDomain \u003e GroupIdList \u003e DomainList \u003e DomainIdList。", "example": "yes" }, { "name": "DomainList", "type": "array", "required": false, "description": "要搜索的域名列表。", "example": "[\"dnspod.cn\",\"dnspod.com\"]", "item_type": "string" }, { "name": "DomainIdList", "type": "array", "required": false, "description": "要搜索的域名 ID 列表。", "example": "[72203,72204]", "item_type": "integer" }, { "name": "GroupIdList", "type": "array", "required": false, "description": "要搜索的域名分组 ID 列表。", "example": "[9,10]", "item_type": "integer" }, { "name": "RecordType", "type": "string", "required": false, "description": "记录类型筛选", "example": "A" }, { "name": "SubKeyword", "type": "string", "required": false, "description": "子域名筛选", "example": "www" }, { "name": "ValueKeyword", "type": "string", "required": false, "description": "记录值筛选", "example": "192" }, { "name": "Area", "type": "string", "required": false, "description": "线路筛选", "example": "默认" }, { "name": "Remark", "type": "string", "required": false, "description": "备注筛选", "example": "备注" }, { "name": "Enabled", "type": "string", "required": false, "description": "记录状态筛选 1：正常 0：暂停", "example": "1" } ], "required": [] }, { "name": "DescribeDomainCustomLineList", "description": "获取域名的自定义线路列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1009" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainFilterList", "description": "获取域名筛选列表备注：新添加的解析记录存在短暂的索引延迟，如果查询不到新增记录，请在 30 秒后重试", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": true, "description": "根据域名分组类型获取域名。可取值为 ALL，MINE，SHARE，RECENT。 ALL：全部 MINE：我的域名 SHARE：共享给我的域名 RECENT：最近操作过的域名", "example": "ALL" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录开始的偏移, 第一条记录为 0, 依次类推。默认值为 0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "要获取的域名数量, 比如获取 20 个, 则为 20。默认值为 5000。如果账户中的域名数量超过了 5000, 将会强制分页并且只返回前 5000 条, 这时需要通过 Offset 和 Limit 参数去获取其它域名。", "example": "20" }, { "name": "GroupId", "type": "array", "required": false, "description": "根据域名分组 id 获取域名", "example": "[1]", "item_type": "integer" }, { "name": "Keyword", "type": "string", "required": false, "description": "根据关键字获取域名。", "example": "qq" }, { "name": "SortField", "type": "string", "required": false, "description": "排序字段。可取值为 NAME，STATUS，RECORDS，GRADE，UPDATED_ON。 NAME：域名名称 STATUS：域名状态 RECORDS：记录数量 GRADE：套餐等级 UPDATED_ON：更新时间", "example": "NAME" }, { "name": "SortType", "type": "string", "required": false, "description": "排序类型，升序：ASC，降序：DESC。", "example": "ASC" }, { "name": "Status", "type": "array", "required": false, "description": "根据域名状态获取域名。可取值为 ENABLE，LOCK，PAUSE，SPAM。 ENABLE：正常 LOCK：锁定 PAUSE：暂停 SPAM：封禁", "example": "[\"ENABLE\"]", "item_type": "string" }, { "name": "Package", "type": "array", "required": false, "description": "根据套餐获取域名，可通过 DescribeDomain 或 DescribeDomainList 接口 Grade 字段获取。", "example": "[\"DP_FREE\"]", "item_type": "string" }, { "name": "Remark", "type": "string", "required": false, "description": "根据备注信息获取域名。", "example": "备注" }, { "name": "UpdatedAtBegin", "type": "string", "required": false, "description": "要获取域名的更新时间起始时间点，如 '2021-05-01 03:00:00'。", "example": "2021-05-01 03:00:00" }, { "name": "UpdatedAtEnd", "type": "string", "required": false, "description": "要获取域名的更新时间终止时间点，如 '2021-05-10 20:00:00'。", "example": "2021-05-10 20:00:00" }, { "name": "RecordCountBegin", "type": "integer", "required": false, "description": "要获取域名的记录数查询区间起点。", "example": "10" }, { "name": "RecordCountEnd", "type": "integer", "required": false, "description": "要获取域名的记录数查询区间终点。", "example": "100" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID，\"帐号中心-项目管理\"拿到项目ID", "example": "-1" }, { "name": "Tags", "type": "array", "required": false, "description": "标签过滤", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "test1" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签键", "example": "val1", "item_type": "string" } ] } ], "required": [ "Type" ] }, { "name": "DescribeDomainGroupList", "description": "获取域名分组列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDomainList", "description": "获取域名列表", "status": "online", "parameters": [ { "name": "Type", "type": "string", "required": false, "description": "域名分组类型，默认为ALL。可取值为ALL，MINE，SHARE，ISMARK，PAUSE，VIP，RECENT，SHARE_OUT，FREE。", "example": "ALL" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录开始的偏移, 第一条记录为 0, 依次类推。默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "要获取的域名数量, 比如获取20个, 则为20。默认值为3000。", "example": "20" }, { "name": "GroupId", "type": "integer", "required": false, "description": "分组ID, 获取指定分组的域名，可以通过接口DescribeDomainGroupList查看当前域名分组信息", "example": "1" }, { "name": "Keyword", "type": "string", "required": false, "description": "根据关键字搜索域名", "example": "qq" }, { "name": "Tags", "type": "array", "required": false, "description": "标签过滤", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": true, "description": "标签键", "example": "test1" }, { "name": "TagValue", "type": "array", "required": false, "description": "标签键", "example": "val1", "item_type": "string" } ] } ], "required": [] }, { "name": "DescribeDomainLogList", "description": "获取域名日志", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" }, { "name": "Offset", "type": "integer", "required": false, "description": "记录开始的偏移，第一条记录为 0，依次类推，默认为0", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "共要获取的日志条数，比如获取20条，则为20，默认为500条，单次最多获取500条。", "example": "100" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainPreview", "description": "获取域名概览信息", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainPurview", "description": "获取域名权限", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainShareInfo", "description": "获取域名共享信息", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainShareUserList", "description": "获取指定域名的已共享列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "61" } ], "required": [ "Domain" ] }, { "name": "DescribeDomainVipList", "description": "获取套餐列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制数量，默认值为20。", "example": "20" }, { "name": "Keyword", "type": "string", "required": false, "description": "通过关键字搜索域名关联的套餐，默认值为空，为空时不作为筛选条件。", "example": "dnspod.cn" }, { "name": "ResourceIdList", "type": "array", "required": false, "description": "使用资源ID列表查询", "example": "[\"f815b34b\", \"a4ba8c4f\"]", "item_type": "string" }, { "name": "GradeList", "type": "array", "required": false, "description": "需要筛选的套餐版本", "example": "[\"DP_Plus\",\"DP_Ultra\"]", "item_type": "string" }, { "name": "GetUnbindResource", "type": "boolean", "required": false, "description": "是否只获取未绑定域名套餐", "example": "true" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeDomainWhois", "description": "获取域名Whois信息", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" } ], "required": [ "Domain" ] }, { "name": "DescribeFileInfoByJobId", "description": "根据批量任务ID获取生成文件信息", "status": "online", "parameters": [ { "name": "JobId", "type": "integer", "required": true, "description": "任务ID", "example": "1808638" } ], "required": [ "JobId" ] }, { "name": "DescribeLineGroupList", "description": "获取域名的线路分组列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Length", "type": "integer", "required": false, "description": "限制数量，传0或不传会返回所有。", "example": "20" }, { "name": "SortType", "type": "string", "required": false, "description": "按自定义线路分组名称排序的方向。升序传asc，降序传desc。", "example": "desc" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Domain" ] }, { "name": "DescribePackageDetail", "description": "获取各套餐配置详情", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRecord", "description": "获取记录信息", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "162" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain", "RecordId" ] }, { "name": "DescribeRecordExistExceptDefaultNS", "description": "判断是否有除系统默认的@-NS记录之外的记录存在", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1923" } ], "required": [ "Domain" ] }, { "name": "DescribeRecordFilterList", "description": "获取某个域名下的解析记录列表备注： 1. 新添加的解析记录存在短暂的索引延迟，如果查询不到新增记录，请在 30 秒后重试 2. API获取的记录总条数会比控制台多2条，原因是：为了防止用户误操作导致解析服务不可用，对2021-10-29 14:24:26之后添加的域名，在控制台都不显示这2条NS记录。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "要获取的解析记录所属的域名。", "example": "shenjianing.com" }, { "name": "DomainId", "type": "integer", "required": false, "description": "要获取的解析记录所属的域名 Id，如果传了 DomainId，系统将会忽略 Domain 参数。", "example": "81345824" }, { "name": "SubDomain", "type": "string", "required": false, "description": "根据解析记录的主机头获取解析记录。默认模糊匹配。可以通过设置 IsExactSubdomain 参数为 true 进行精确查找。", "example": "www" }, { "name": "RecordType", "type": "array", "required": false, "description": "获取某些类型的解析记录，如 A，CNAME，NS，AAAA，显性URL，隐性URL，CAA，SPF等。", "example": "[\"A\"]", "item_type": "string" }, { "name": "RecordLine", "type": "array", "required": false, "description": "获取某些线路ID的解析记录。", "example": "[\"0\"]", "item_type": "string" }, { "name": "GroupId", "type": "array", "required": false, "description": "获取某些分组下的解析记录时，传这个分组 Id。", "example": "[23]", "item_type": "integer" }, { "name": "Keyword", "type": "string", "required": false, "description": "通过关键字搜索解析记录，当前支持搜索主机头和记录值", "example": "book" }, { "name": "SortField", "type": "string", "required": false, "description": "排序字段，支持 NAME，LINE，TYPE，VALUE，WEIGHT，MX，TTL，UPDATED_ON 几个字段。 NAME：解析记录的主机头 LINE：解析记录线路 TYPE：解析记录类型 VALUE：解析记录值 WEIGHT：权重 MX：MX 优先级 TTL：解析记录缓存时间 UPDATED_ON：解析记录更新时间", "example": "NAME" }, { "name": "SortType", "type": "string", "required": false, "description": "排序方式，升序：ASC，降序：DESC。默认值为ASC。", "example": "ASC" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。如果入参携带\"Domain\",\"offset\",\"Limit\" 这3个以外的参数，记录结果限制最大3000条", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，当前Limit最大支持3000。默认值为100。", "example": "100" }, { "name": "RecordValue", "type": "string", "required": false, "description": "根据解析记录的值获取解析记录", "example": "1.1.1.1" }, { "name": "RecordStatus", "type": "array", "required": false, "description": "根据解析记录的状态获取解析记录。可取值为 ENABLE，DISABLE。 ENABLE：正常 DISABLE：暂停", "example": "[\"ENABLE\"]", "item_type": "string" }, { "name": "WeightBegin", "type": "integer", "required": false, "description": "要获取解析记录权重查询区间起点。", "example": "1" }, { "name": "WeightEnd", "type": "integer", "required": false, "description": "要获取解析记录权重查询区间终点。", "example": "100" }, { "name": "MXBegin", "type": "integer", "required": false, "description": "要获取解析记录 MX 优先级查询区间起点。", "example": "1" }, { "name": "MXEnd", "type": "integer", "required": false, "description": "要获取解析记录 MX 优先级查询区间终点。", "example": "10" }, { "name": "TTLBegin", "type": "integer", "required": false, "description": "要获取解析记录 TTL 查询区间起点。", "example": "60" }, { "name": "TTLEnd", "type": "integer", "required": false, "description": "要获取解析记录 TTL 查询区间终点。", "example": "600" }, { "name": "UpdatedAtBegin", "type": "string", "required": false, "description": "要获取解析记录更新时间查询区间起点。", "example": "2023-01-16 00:00:00" }, { "name": "UpdatedAtEnd", "type": "string", "required": false, "description": "要获取解析记录更新时间查询区间终点。", "example": "2023-01-17 00:00:00" }, { "name": "Remark", "type": "string", "required": false, "description": "根据解析记录的备注获取解析记录。", "example": "解析记录备注" }, { "name": "IsExactSubDomain", "type": "boolean", "required": false, "description": "是否根据 Subdomain 参数进行精确查找。", "example": "false" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "-1" } ], "required": [ "Domain" ] }, { "name": "DescribeRecordGroupList", "description": "查询解析记录分组列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页开始位置", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页每页数", "example": "10" } ], "required": [ "Domain" ] }, { "name": "DescribeRecordLineCategoryList", "description": "按分类返回线路列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "要查询线路列表的域名。", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "要查询线路列表的域名 ID。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain。", "example": "97213027" } ], "required": [ "Domain" ] }, { "name": "DescribeRecordLineList", "description": "获取等级允许的线路", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名。", "example": "dnspod.cn" }, { "name": "DomainGrade", "type": "string", "required": true, "description": "域名套餐等级。旧套餐：D_FREE、D_PLUS、D_EXTRA、D_EXPERT、D_ULTRA 、DP_EXTRA 分别对应免费套餐、个人豪华、企业 I、企业 II、企业 III、企业基础版。新套餐：DP_FREE、DP_PLUS、DP_EXPERT、DP_ULTRA 分别对应新免费、专业版、企业版、尊享版。", "example": "DP_PLUS" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain", "DomainGrade" ] }, { "name": "DescribeRecordList", "description": "获取某个域名下的解析记录列表备注： 1. 新添加的解析记录存在短暂的索引延迟，如果查询不到新增记录，请在 30 秒后重试 2. API获取的记录总条数会比控制台多2条，原因是：为了防止用户误操作导致解析服务不可用，对2021-10-29 14:24:26之后添加的域名，在控制台都不显示这2条NS记录。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "81345824" }, { "name": "Subdomain", "type": "string", "required": false, "description": "解析记录的主机头，如果传了此参数，则只会返回此主机头对应的解析记录", "example": "www" }, { "name": "RecordType", "type": "string", "required": false, "description": "获取某种类型的解析记录，如 A，CNAME，NS，AAAA，显性URL，隐性URL，CAA，SPF等", "example": "A" }, { "name": "RecordLine", "type": "string", "required": false, "description": "获取某条线路名称的解析记录。可以通过接口DescribeRecordLineList查看当前域名允许的线路信息", "example": "默认" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "获取某个线路Id对应的解析记录，如果传RecordLineId，系统会忽略RecordLine参数。可以通过接口DescribeRecordLineList查看当前域名允许的线路信息", "example": "0" }, { "name": "GroupId", "type": "integer", "required": false, "description": "获取某个分组下的解析记录时，传这个分组Id。可通过DescribeRecordGroupList接口获取所有分组", "example": "23" }, { "name": "Keyword", "type": "string", "required": false, "description": "通过关键字搜索解析记录，当前支持搜索主机头和记录值", "example": "book" }, { "name": "SortField", "type": "string", "required": false, "description": "排序字段，支持 name,line,type,value,weight,mx,ttl,updated_on 几个字段。", "example": "type" }, { "name": "SortType", "type": "string", "required": false, "description": "排序方式，正序：ASC，逆序：DESC。默认值为ASC。", "example": "asc" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，当前Limit最大支持3000。默认值为100。", "example": "100" } ], "required": [ "Domain" ] }, { "name": "DescribeRecordSnapshotRollbackResult", "description": "查询解析记录重新回滚的结果", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "JobId", "type": "integer", "required": true, "description": "回滚任务 ID", "example": "1234131" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain", "JobId" ] }, { "name": "DescribeRecordType", "description": "获取等级允许的记录类型", "status": "online", "parameters": [ { "name": "DomainGrade", "type": "string", "required": true, "description": "域名等级。 + 旧套餐：D_FREE、D_PLUS、D_EXTRA、D_EXPERT、D_ULTRA 分别对应免费套餐、个人豪华、企业1、企业2、企业3。 + 新套餐：DP_FREE、DP_PLUS、DP_EXTRA、DP_EXPERT、DP_ULTRA 分别对应新免费、个人专业版、企业创业版、企业标准版、企业旗舰版。", "example": "DP_Plus" } ], "required": [ "DomainGrade" ] }, { "name": "DescribeResolveCount", "description": "查看域名的解析量", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "要查询解析量的域名", "example": "example.com" }, { "name": "StartDate", "type": "string", "required": true, "description": "查询的开始时间，格式：YYYY-MM-DD，最多允许查询最近32天的数据。", "example": "2022-06-08" }, { "name": "EndDate", "type": "string", "required": true, "description": "查询的结束时间，格式：YYYY-MM-DD，最多允许查询最近32天的数据。", "example": "2022-06-14" }, { "name": "DnsFormat", "type": "string", "required": true, "description": "数据统计格式，取值为minute、hour、day，分别表示按十分钟、小时、天统计数据", "example": "minute" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "435436" } ], "required": [ "Domain", "StartDate", "EndDate", "DnsFormat" ] }, { "name": "DescribeSnapshotConfig", "description": "查询解析快照配置", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "121313" } ], "required": [ "Domain" ] }, { "name": "DescribeSnapshotList", "description": "查询快照列表", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain" ] }, { "name": "DescribeSnapshotRollbackResult", "description": "查询快照回滚结果", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "TaskId", "type": "integer", "required": true, "description": "快照回滚任务 ID", "example": "124" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain", "TaskId" ] }, { "name": "DescribeSnapshotRollbackTask", "description": "查询最近一次回滚", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain" ] }, { "name": "DescribeSubdomainAnalytics", "description": "统计子域名的解析量，帮助您了解流量情况、时间段分布。支持查看近 3 个月内的统计情况。仅付费套餐域名可用。", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "要查询解析量的域名", "example": "dnspod.cn" }, { "name": "StartDate", "type": "string", "required": true, "description": "查询的开始时间，格式：YYYY-MM-DD", "example": "2024-12-30" }, { "name": "EndDate", "type": "string", "required": true, "description": "查询的结束时间，格式：YYYY-MM-DD", "example": "2024-12-30" }, { "name": "Subdomain", "type": "string", "required": true, "description": "要查询解析量的子域名", "example": "www" }, { "name": "DnsFormat", "type": "string", "required": false, "description": "DATE:按天维度统计 HOUR:按小时维度统计", "example": "DATE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "12620688" } ], "required": [ "Domain", "StartDate", "EndDate", "Subdomain" ] }, { "name": "DescribeSubdomainValidateStatus", "description": "查看添加子域名 Zone 域解析 TXT 记录值验证状态", "status": "online", "parameters": [ { "name": "DomainZone", "type": "string", "required": true, "description": "要查看 TXT 记录校验状态的子域名 Zone 域。", "example": "sub.dnspod.cn" } ], "required": [ "DomainZone" ] }, { "name": "DescribeUserDetail", "description": "获取账户信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeVASStatistic", "description": "获取域名增值服务用量", "status": "online", "parameters": [ { "name": "DomainId", "type": "integer", "required": true, "description": "域名ID", "example": "54863243" } ], "required": [ "DomainId" ] }, { "name": "DescribeVasList", "description": "获取增值服务列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认值为0。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数量，默认值为20。", "example": "20" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID", "example": "12" }, { "name": "ResourceIdList", "type": "array", "required": false, "description": "使用资源 ID 列表查询", "example": "[\"f815b34b\", \"a4ba8c4f\"]", "item_type": "string" }, { "name": "LimitType", "type": "string", "required": false, "description": "增值服务类型", "example": "D_URLCOUNT" } ], "required": [] }, { "name": "DownloadSnapshot", "description": "下载快照", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照记录 ID", "example": "EG34GE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain", "SnapshotId" ] }, { "name": "ModifyDomainCNAMESpeedupStatusBatch", "description": "批量修改域名CNAME加速状态", "status": "online", "parameters": [ { "name": "DomainList", "type": "array", "required": true, "description": "域名列表", "example": "[\"dnspod.com\", \"dnspod.cn\"]", "item_type": "string" }, { "name": "Status", "type": "string", "required": true, "description": "状态。ENABLE-开启；DISABLE-关闭。", "example": "ENABLE" } ], "required": [ "DomainList", "Status" ] }, { "name": "ModifyDomainCustomLine", "description": "修改域名的自定义线路", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Name", "type": "string", "required": true, "description": "修改后的自定义线路名称，如果不修改名称，需要和PreName保持一致", "example": "testline8" }, { "name": "Area", "type": "string", "required": true, "description": "自定义线路IP段，用-分割", "example": "6.6.6.1-6.6.6.3" }, { "name": "PreName", "type": "string", "required": true, "description": "修改前的自定义线路名称", "example": "testline8" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Domain", "Name", "Area", "PreName" ] }, { "name": "ModifyDomainLock", "description": "锁定域名", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "LockDays", "type": "integer", "required": true, "description": "域名要锁定的天数，最多可锁定的天数可以通过DescribeDomainPurview接口获取。", "example": "30" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain", "LockDays" ] }, { "name": "ModifyDomainOwner", "description": "域名过户", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Account", "type": "string", "required": true, "description": "域名需要转入的账号Uin", "example": "100000000328" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" } ], "required": [ "Domain", "Account" ] }, { "name": "ModifyDomainRecursiveStatusBatch", "description": "批量修改域名递归解析加速状态", "status": "online", "parameters": [ { "name": "DomainList", "type": "array", "required": true, "description": "域名列表", "example": "[\"dnspod.com\", \"dnspod.cn\"]", "item_type": "string" }, { "name": "Status", "type": "string", "required": true, "description": "ENABLE-开启；DISABLE-关闭。", "example": "ENABLE" } ], "required": [ "DomainList", "Status" ] }, { "name": "ModifyDomainRemark", "description": "设置域名备注", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" }, { "name": "Remark", "type": "string", "required": false, "description": "域名备注，删除备注请提交空内容。", "example": "这是XXX专用域名" } ], "required": [ "Domain" ] }, { "name": "ModifyDomainStatus", "description": "修改域名状态", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "Status", "type": "string", "required": true, "description": "域名状态，\"enable\"、\"disable\" 分别代表启用和暂停", "example": "enable" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "61" } ], "required": [ "Domain", "Status" ] }, { "name": "ModifyDomainToGroup", "description": "修改域名所属分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "myfm.cc" }, { "name": "GroupId", "type": "integer", "required": true, "description": "域名分组ID", "example": "32424" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID,域名ID，参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain", "example": "14535" } ], "required": [ "Domain", "GroupId" ] }, { "name": "ModifyDomainUnlock", "description": "域名锁定解锁", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "LockCode", "type": "string", "required": true, "description": "域名解锁码，锁定的时候会返回。", "example": "M3xkbnNwb2Quc2l0ZXwxNjE3MzMwNjQzfGZhYjA3YTI0ODcwNzIzMmNjNjI5YzZh" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain", "LockCode" ] }, { "name": "ModifyDynamicDNS", "description": "更新动态 DNS 记录", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录ID。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "16411867" }, { "name": "RecordLine", "type": "string", "required": true, "description": "记录线路，中文，比如：默认。", "example": "联通" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "12620688" }, { "name": "SubDomain", "type": "string", "required": false, "description": "主机记录，如 www，如果不传，默认为 @。", "example": "www" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "线路的 ID，英文字符串，比如：10=1。参数RecordLineId优先级高于RecordLine，如果同时传递二者，优先使用RecordLineId参数。", "example": "10=1" }, { "name": "Value", "type": "string", "required": false, "description": "IP 地址，支持 IPv4、IPv6，例如 119.29.29.29 或者 2402:4e00::", "example": "119.29.29.29" }, { "name": "Ttl", "type": "integer", "required": false, "description": "TTL值，如果不传，默认为域名的TTL值。", "example": "600" } ], "required": [ "Domain", "RecordId", "RecordLine" ] }, { "name": "ModifyLineGroup", "description": "修改域名的线路分组", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "自定义线路分组的名称。", "example": "testgroup99" }, { "name": "Lines", "type": "string", "required": true, "description": "自定义线路分组包含的线路列表，包含多个线路时用英文逗号分隔。例如，铁通,奇虎", "example": "电信,移动" }, { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "LineGroupId", "type": "integer", "required": true, "description": "自定义线路分组ID", "example": "10" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID，如果传了DomainId，系统将会忽略Domain参数，优先使用DomainId", "example": "1009" } ], "required": [ "Name", "Lines", "Domain", "LineGroupId" ] }, { "name": "ModifyPackageAutoRenew", "description": "DNS 解析套餐自动续费设置", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "计费资源ID", "example": "a0bed80e" }, { "name": "Status", "type": "string", "required": true, "description": "enable 开启自动续费；disable 关闭自动续费", "example": "enable" } ], "required": [ "ResourceId", "Status" ] }, { "name": "ModifyPackageDomain", "description": "套餐绑定、解绑、更换域名", "status": "online", "parameters": [ { "name": "Operation", "type": "string", "required": true, "description": "操作类型：change: 套餐换域名；unbind: 解绑套餐域名；bind: 套餐绑定域名。", "example": "change" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名ID。Operation为change时必传，代表更换前的域名。", "example": "49372" }, { "name": "NewDomainId", "type": "integer", "required": false, "description": "域名ID。Operation为change或bind时必传，代表更换后或要绑定的域名。", "example": "548874" }, { "name": "ResourceId", "type": "string", "required": false, "description": "套餐资源ID。Operation为bind或unbind时必传，代表将要操作的套餐资源。", "example": "4f83dbe5" } ], "required": [ "Operation" ] }, { "name": "ModifyRecord", "description": "修改记录", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordType", "type": "string", "required": true, "description": "记录类型，可通过接口DescribeRecordType获得，大写英文，比如：A 。", "example": "A" }, { "name": "RecordLine", "type": "string", "required": true, "description": "记录线路，可以通过接口DescribeRecordLineList查看当前域名允许的线路信息。比如：默认。", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "记录值，如 IP : 200.200.200.200， CNAME : cname.dnspod.com.， MX : mail.dnspod.com.。", "example": "200.200.200.200" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "162" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" }, { "name": "SubDomain", "type": "string", "required": false, "description": "主机记录，如 www，如果不传，默认为 @。", "example": "admin" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "线路的 ID，可以通过接口DescribeRecordLineList查看当前域名允许的线路信息，比如：10=1。参数RecordLineId优先级高于RecordLine，如果同时传递二者，优先使用RecordLineId参数。", "example": "10=1" }, { "name": "MX", "type": "integer", "required": false, "description": "MX 优先级，当记录类型是 MX、HTTPS、SVCB 时必填，范围1-65535。", "example": "10" }, { "name": "TTL", "type": "integer", "required": false, "description": "TTL，范围1-604800，不同等级域名最小值不同。", "example": "600" }, { "name": "Weight", "type": "integer", "required": false, "description": "权重信息，0到100的整数。0 表示关闭，不传该参数，表示不设置权重信息。", "example": "20" }, { "name": "Status", "type": "string", "required": false, "description": "记录初始状态，取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ，如果传入 DISABLE，解析不会生效，也不会验证负载均衡的限制。", "example": "ENABLE" }, { "name": "Remark", "type": "string", "required": false, "description": "记录的备注信息。传空删除备注。", "example": "这是备注" }, { "name": "DnssecConflictMode", "type": "string", "required": false, "description": "开启DNSSEC时，强制将其它记录修改为CNAME/URL记录", "example": "force" } ], "required": [ "Domain", "RecordType", "RecordLine", "Value", "RecordId" ] }, { "name": "ModifyRecordBatch", "description": "批量修改记录", "status": "online", "parameters": [ { "name": "RecordIdList", "type": "array", "required": true, "description": "记录ID数组。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId。单次最多修改5000条记录。", "example": "[15736895]", "item_type": "integer" }, { "name": "Change", "type": "string", "required": true, "description": "要修改的字段，可选值为 [“sub_domain”、”record_type”、”area”、”value”、”mx”、”ttl”、”status”] 中的某一个。", "example": "record_type" }, { "name": "ChangeTo", "type": "string", "required": true, "description": "修改为，具体依赖 change 字段，必填参数。", "example": "MX" }, { "name": "Value", "type": "string", "required": false, "description": "要修改到的记录值，仅当 change 字段为 “record_type” 时为必填参数。", "example": "mail.dnspod.cn" }, { "name": "MX", "type": "string", "required": false, "description": "MX 优先级，当记录类型是 MX、HTTPS、SVCB 时必填，范围1-65535。", "example": "5" } ], "required": [ "RecordIdList", "Change", "ChangeTo" ] }, { "name": "ModifyRecordFields", "description": "修改记录可选字段", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。", "example": "162" }, { "name": "FieldList", "type": "array", "required": true, "description": "要修改的记录属性和值，支持：sub_domain，record_line，record_line_id，record_type，value，ttl，status，mx，weight", "example": "无", "item_type": "object", "children": [ { "name": "Key", "type": "string", "required": true, "description": "键", "example": "ttl" }, { "name": "Value", "type": "string", "required": false, "description": "值", "example": "600" } ] }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1923" } ], "required": [ "Domain", "RecordId", "FieldList" ] }, { "name": "ModifyRecordGroup", "description": "修改记录分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "GroupName", "type": "string", "required": true, "description": "分组名称", "example": "分组2" }, { "name": "GroupId", "type": "integer", "required": true, "description": "要修改的分组 ID，可通过DescribeRecordGroupList接口获取所有记录分组", "example": "146" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain", "GroupName", "GroupId" ] }, { "name": "ModifyRecordRemark", "description": "设置记录备注", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "162" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" }, { "name": "Remark", "type": "string", "required": false, "description": "解析记录备注，删除备注请提交空内容。", "example": "这是解析记录的备注" } ], "required": [ "Domain", "RecordId" ] }, { "name": "ModifyRecordStatus", "description": "修改解析记录的状态", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "162" }, { "name": "Status", "type": "string", "required": true, "description": "记录的状态。取值范围为 ENABLE 和 DISABLE。如果传入 DISABLE，解析不会生效，也不会验证负载均衡的限制。", "example": "ENABLE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "1923" } ], "required": [ "Domain", "RecordId", "Status" ] }, { "name": "ModifyRecordToGroup", "description": "将记录添加到分组", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "GroupId", "type": "integer", "required": true, "description": "分组 ID，可通过DescribeRecordGroupList接口获取所有记录分组", "example": "145" }, { "name": "RecordId", "type": "string", "required": true, "description": "记录 ID，多个 ID 用竖线“|”分割，可以通过接口DescribeRecordList查到所有的解析记录列表以及对应的RecordId", "example": "123232|2343232" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain", "GroupId", "RecordId" ] }, { "name": "ModifySnapshotConfig", "description": "修改快照配置", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "Period", "type": "string", "required": true, "description": "备件间隔：空字符串-不备份，half_hour-每半小时，hourly-每小时，daily-每天，monthly-每月", "example": "daily" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" } ], "required": [ "Domain", "Period" ] }, { "name": "ModifySubdomainStatus", "description": "暂停子域名的解析记录", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordType", "type": "string", "required": true, "description": "记录类型。允许的值为A、CNAME、MX、TXT、NS、AAAA、SPF、SRV、CAA、URL、URL1。若要传多个，用英文逗号分隔，例如A,TXT,CNAME。", "example": "A,TXT,URL" }, { "name": "Status", "type": "string", "required": true, "description": "记录状态。允许的值为disable。", "example": "disable" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1923" }, { "name": "SubDomain", "type": "string", "required": false, "description": "主机记录，如 www，如果不传，默认为 @。", "example": "www" } ], "required": [ "Domain", "RecordType", "Status" ] }, { "name": "ModifyTXTRecord", "description": "修改TXT记录", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "RecordLine", "type": "string", "required": true, "description": "记录线路，通过 API 记录线路获得，中文，比如：默认。", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "记录值，如 IP : 200.200.200.200， CNAME : cname.dnspod.com.， MX : mail.dnspod.com.。", "example": "200.200.200.200" }, { "name": "RecordId", "type": "integer", "required": true, "description": "记录 ID 。", "example": "162" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "1923" }, { "name": "SubDomain", "type": "string", "required": false, "description": "主机记录，如 www，如果不传，默认为 @。", "example": "m" }, { "name": "RecordLineId", "type": "string", "required": false, "description": "线路的 ID，通过 API 记录线路获得，字符串，比如：10=1。参数RecordLineId优先级高于RecordLine，如果同时传递二者，优先使用RecordLineId参数。", "example": "10=1" }, { "name": "TTL", "type": "integer", "required": false, "description": "TTL，范围1-604800，不同等级域名最小值不同。单位：秒", "example": "600" }, { "name": "Status", "type": "string", "required": false, "description": "记录初始状态，取值范围为 ENABLE 和 DISABLE 。默认为 ENABLE ，如果传入 DISABLE，解析不会生效，也不会验证负载均衡的限制。", "example": "ENABLE" }, { "name": "Remark", "type": "string", "required": false, "description": "记录的备注信息。传空删除备注。", "example": "这是备注" } ], "required": [ "Domain", "RecordLine", "Value", "RecordId" ] }, { "name": "ModifyVasAutoRenewStatus", "description": "增值服务自动续费设置", "status": "online", "parameters": [ { "name": "ResourceId", "type": "string", "required": true, "description": "资源ID。可以从控制台查看所有的资源", "example": "a0bed80e" }, { "name": "Status", "type": "string", "required": true, "description": "enable 开启自动续费；disable 关闭自动续费", "example": "enable" } ], "required": [ "ResourceId", "Status" ] }, { "name": "PayOrderWithBalance", "description": "DNSPod商品余额支付", "status": "online", "parameters": [ { "name": "BigDealIdList", "type": "array", "required": true, "description": "需要支付的大订单号数组", "example": "[ \"20251105290113163237071\" ]", "item_type": "string" }, { "name": "VoucherIdList", "type": "array", "required": false, "description": "代金券ID数组。可以从控制台查到拥有的代金券", "example": "[ \"BBTXCCOBCBJFKBYNNPVY3E\" ]", "item_type": "string" } ], "required": [ "BigDealIdList" ] }, { "name": "RollbackRecordSnapshot", "description": "重新回滚指定解析记录快照", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "dnspod.cn" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照 ID。可以通过接口DescribeSnapshotList查询快照 ID", "example": "BCED853D" }, { "name": "RecordList", "type": "array", "required": true, "description": "解析记录信息", "example": "无", "item_type": "object", "children": [ { "name": "SubDomain", "type": "string", "required": true, "description": "子域名", "example": "www" }, { "name": "RecordType", "type": "string", "required": true, "description": "记录类型", "example": "A" }, { "name": "RecordLine", "type": "string", "required": true, "description": "解析线路", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "解析值", "example": "0.0.0.0" }, { "name": "TTL", "type": "string", "required": true, "description": "TTL(秒)", "example": "600" }, { "name": "RecordId", "type": "string", "required": false, "description": "解析记录 ID", "example": "15689601" }, { "name": "MX", "type": "string", "required": false, "description": "MX优先级注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Weight", "type": "string", "required": false, "description": "权重注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "Reason", "type": "string", "required": false, "description": "失败原因注意：此字段可能返回 null，表示取不到有效值。", "example": "线路不存在" } ] }, { "name": "TaskId", "type": "integer", "required": true, "description": "之前的快照回滚任务 ID。可从RollbackSnapshot接口获取", "example": "45" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。可以通过接口DescribeDomainList查到所有的Domain以及DomainId", "example": "3123" } ], "required": [ "Domain", "SnapshotId", "RecordList", "TaskId" ] }, { "name": "RollbackSnapshot", "description": "回滚快照", "status": "online", "parameters": [ { "name": "Domain", "type": "string", "required": true, "description": "域名", "example": "xxyy.com" }, { "name": "SnapshotId", "type": "string", "required": true, "description": "快照记录 ID", "example": "EG34GE" }, { "name": "DomainId", "type": "integer", "required": false, "description": "域名 ID 。参数 DomainId 优先级比参数 Domain 高，如果传递参数 DomainId 将忽略参数 Domain 。", "example": "3123" }, { "name": "RecordList", "type": "array", "required": false, "description": "指定需要回滚的记录", "example": "无", "item_type": "object", "children": [ { "name": "SubDomain", "type": "string", "required": true, "description": "子域名", "example": "www" }, { "name": "RecordType", "type": "string", "required": true, "description": "记录类型", "example": "A" }, { "name": "RecordLine", "type": "string", "required": true, "description": "解析线路", "example": "默认" }, { "name": "Value", "type": "string", "required": true, "description": "解析值", "example": "0.0.0.0" }, { "name": "TTL", "type": "string", "required": true, "description": "TTL(秒)", "example": "600" }, { "name": "RecordId", "type": "string", "required": false, "description": "解析记录 ID", "example": "15689601" }, { "name": "MX", "type": "string", "required": false, "description": "MX优先级注意：此字段可能返回 null，表示取不到有效值。", "example": "0" }, { "name": "Weight", "type": "string", "required": false, "description": "权重注意：此字段可能返回 null，表示取不到有效值。", "example": "20" }, { "name": "Reason", "type": "string", "required": false, "description": "失败原因注意：此字段可能返回 null，表示取不到有效值。", "example": "线路不存在" } ] } ], "required": [ "Domain", "SnapshotId" ] } ] }