# 查询弹性公网IP的反向解析记录列表 - ListPtrs #### 功能介绍 查询弹性公网IP的反向解析记录列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-dns/zh-cn_topic_0037134405.html)。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dns/dns_api_70000.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dns:ptr:list | List | ptr \* | - | - | - | | dns:ptr:list | List | - | - g:RequestTag/\ - g:TagKeys - g:EnterpriseProjectId | - | - | #### URI GET /v2.1/ptrs 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | marker | 否 | String | **参数解释：** 分页查询起始的资源ID，为空时为查询第一页。 获取方式：从上一页查询结果中最后一个资源的ID获取。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | limit | 否 | Integer | **参数解释：** 分页查询时配置每页返回的资源个数。 **约束限制：** 不涉及。 **取值范围：** 0\~500，取值一般为10、20、50。 **默认取值：** 500 | | offset | 否 | Integer | **参数解释：** 分页查询起始偏移量，表示从偏移量的下一个资源开始查询。 **约束限制：** 当设置marker不为空时，以marker为分页起始标识，offset不生效。 **取值范围：** 0\~2147483647。 **默认取值：** 0 | | enterprise_project_id | 否 | String | **参数解释：** 反向解析关联的企业项目ID。 获取方式：通过查询企业项目列表接口获取。 **约束限制：** 不涉及。 **取值范围：** 长度不超过36个字符。 **默认取值：** 不涉及。 | | tags | 否 | String | **参数解释：** 资源标签，包括标签键和标签值。 取值格式：key1,value1\|key2,value2。该字段为字符串，按key1,value1\|key2,value2格式表示多个标签，每个标签含key（标签键，必选）和value（标签值，可选），用于资源标签的分类管理与筛选。 **约束限制：** 多个标签之间用"\|"分开，每个标签的键值用英文逗号","相隔。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | status | 否 | String | **参数解释：** 资源状态。 **约束限制：** 不涉及。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - ERROR：失败 **默认取值：** 不涉及。 | | resource_type | 否 | String | **参数解释：** 弹性公网IP类型。 **约束限制：** 不涉及。 **取值范围：** - publicip：弹性公网IP（EIP） **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token，用于用户身份认证，调用接口时需在请求头中携带该Token以验证用户身份。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 获取用户Token请参见[获取用户Token](https://support.huaweicloud.com/api-dns/dns_api_30003.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | floatingips | Array of [FloatingIpsPtr] objects | **参数解释：** 反向解析列表。 该字段为数组，每个元素包含弹性公网IP的ID、反向解析记录域名及状态等。 | | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | metadata | [metadata] object | **参数解释：** 返回满足过滤条件的资源总数。 | 表4FloatingIpsPtr | 参数 | 参数类型 | 描述 | |:---|:---|:---| | ptrdnames | Array of strings | **参数解释：** 反向解析记录对应的域名列表，最大个数不超过10个。 该字段为字符串数组，每个元素为一个反向解析记录的域名。 | | id | String | **参数解释：** 反向解析记录的ID。 **取值范围：** 不涉及。 | | publicip | [PublicIpRes] object | **参数解释：** 弹性公网IP（EIP）对象，用于指定反向解析关联的弹性公网IP信息，包括EIP所属区域和EIP ID。 | | description | String | **参数解释：** 对反向解析记录的描述。 **取值范围：** 不涉及。 | | ttl | Integer | **参数解释：** 反向解析记录在本地DNS服务器的缓存时间，缓存时间越长更新生效越慢，以秒为单位。 **取值范围：** 1\~2147483647。 | | status | String | **参数解释：** 资源状态。 **取值范围：** - ACTIVE：正常 - PENDING_CREATE：创建中 - PENDING_UPDATE：更新中 - PENDING_DELETE：删除中 - PENDING_FREEZE：冻结中 - FREEZE：冻结 - ILLEGAL：违规冻结 - POLICE：公安冻结 - ERROR：失败 | | links | [pageLink] object | **参数解释：** 指向当前页和下一页的链接。分页查询需要分页时，需要使用一个next字段指向下一页。 | | enterprise_project_id | String | **参数解释：** 反向解析关联的企业项目ID。 **取值范围：** 最大长度36字节，带"-"连字符的UUID格式，或者是字符串"0"。"0"表示默认企业项目。 | | tags | Array of [tag] objects | **参数解释：** 资源标签。 该字段为数组，每个元素包含标签键和标签值，用于资源标签的分类管理与筛选。 | 表5PublicIpRes | 参数 | 参数类型 | 描述 | |:---|:---|:---| | region | String | **参数解释：** 弹性公网IP（EIP）所属的区域。 **取值范围：** 不涉及。 | | id | String | **参数解释：** 弹性公网IP（EIP）的ID。 **取值范围：** 不涉及。 | | address | String | **参数解释：** 弹性公网IP（EIP）的IP地址。 **取值范围：** 不涉及。 | 表6tag | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释：** 标签键。 **取值范围：** - 长度不超过128个字符。 - 取值可以包含任意语种字母、数字、空格，以及_ . : = + - @特殊字符。 | | value | String | **参数解释：** 标签值。 **取值范围：** - 长度不超过255个字符。 - 取值可以包含任意语种字母、数字、空格，以及_ . : / = + - @特殊字符。 | 表7pageLink | 参数 | 参数类型 | 描述 | |:---|:---|:---| | self | String | **参数解释：** 当前页面的链接。 **取值范围：** 不涉及。 | | next | String | **参数解释：** 下一页的链接。 **取值范围：** 不涉及。 | 表8metadata | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total_count | Integer | **参数解释：** 满足查询条件的资源总数，不受分页（即limit、offset参数）影响。 **取值范围：** 不涉及。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：500** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | message | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 查询弹性公网IP的反向解析记录列表。 ``` GET https://{Endpoint}/v2.1/ptrs ``` #### 响应示例 **状态码：200** ``` { "floatingips" : [ { "ptrdnames" : [ "www.example.com.", "mail.example.com." ], "id" : "9a175b97889f2f3501889fa3a8a66ed0", "publicip" : { "region" : "xxx", "id" : "a1645603-9814-44f9-ba19-1c565af9eb81", "address" : "215.255.1.80" }, "ttl" : 300, "status" : "ACTIVE", "links" : { "self" : "https://{Endpoint}/v2.1/ptrs/9a175b97889f2f3501889fa3a8a66ed0" }, "enterprise_project_id" : "0", "tags" : [ { "key" : "key1", "value" : "value1" } ] } ], "links" : { "self" : "https://{Endpoint}/v2.1/ptrs" }, "metadata" : { "total_count" : 1 } } ``` #### SDK代码示例 SDK代码示例如下。 - [Java] ``` package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dns.v2.region.DnsRegion; import com.huaweicloud.sdk.dns.v2.*; import com.huaweicloud.sdk.dns.v2.model.*; public class ListPtrsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); DnsClient client = DnsClient.newBuilder() .withCredential(auth) .withRegion(DnsRegion.valueOf("")) .build(); ListPtrsRequest request = new ListPtrsRequest(); try { ListPtrsResponse response = client.listPtrs(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } ``` - [Python] ``` # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdns.v2.region.dns_region import DnsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdns.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = BasicCredentials(ak, sk) client = DnsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DnsRegion.value_of("")) \ .build() try: request = ListPtrsRequest() response = client.list_ptrs(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) ``` - [Go] ``` package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dns "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dns/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth, err := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := dns.DnsClientBuilder(). WithRegion(region.ValueOf("")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := dns.NewDnsClient(hcClient) request := &model.ListPtrsRequest{} response, err := client.ListPtrs(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } ``` - [更多] 更多编程语言的SDK代码示例，请参见[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DNS/sdk?api=ListPtrs)的代码示例页签，可生成自动对应的SDK代码示例。 #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询弹性公网IP的反向解析记录列表响应。 | | 400 | 接口错误响应。 | | 500 | 接口错误响应。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-dns/ErrorCode.html)。