文档首页/ 云解析服务 DNS/ API参考/ API/ PTR Record管理/ 查询租户弹性公网IP的PTR记录列表
更新时间:2024-07-09 GMT+08:00
分享

查询租户弹性公网IP的PTR记录列表

功能介绍

查询租户弹性公网IP的PTR记录列表

调用方法

请参见如何调用API

URI

GET /v2/reverse/floatingips

表1 Query参数

参数

是否必选

参数类型

描述

marker

String

分页查询起始的资源ID,为空时为查询第一页。

默认值为空。

limit

Integer

每页返回的资源个数。

取值范围:0~500

取值一般为10,20,50。默认值为500。

offset

Integer

分页查询起始偏移量,表示从偏移量的下一个资源开始查询。

取值范围:0~2147483647

默认值为0。

当前设置marker不为空时,以marker为分页起始标识。

enterprise_project_id

String

反向解析关联的企业项目ID,长度不超过36个字符。

默认值为0。

tags

String

资源标签。

取值格式:key1,value1|key2,value2

多个标签之间用"|"分开,每个标签的键值用英文逗号","相隔。

status

String

资源状态。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。

metadata

metadata object

返回满足过滤条件的资源总数。

floatingips

Array of ListPtrRecordsFloatingResp objects

弹性公网IP的PTR记录ID列表信息。

表4 metadata

参数

参数类型

描述

total_count

Integer

满足查询条件的资源总数,不受分页(即limit、offset参数)影响。

表5 ListPtrRecordsFloatingResp

参数

参数类型

描述

id

String

PTR记录的ID,格式形如{region}:{floatingip_id}。

ptrdname

String

PTR记录对应的域名。

description

String

对PTR记录的描述。

ttl

Integer

PTR记录在本地DNS服务器的缓存时间,缓存时间越长更新生效越慢,以秒为单位。

address

String

弹性公网IP的IP地址。

status

String

资源状态。

action

String

对该资源的当前操作。 取值范围:CREATE,UPDATE,DELETE,NONE。 CREATE:表示创建,UPDATE:表示更新,DELETE:表示删除,NONE:表示无操作

links

pageLink object

指向当前资源或者其他资源的链接。当查询需要分页时,需要包含一个next链接指向下一页。

tags

Array of tag objects

资源标签。

enterprise_project_id

String

反向解析关联的企业项目ID,长度不超过36个字符。

表7 tag

参数

参数类型

描述

key

String

键。最大长度36个unicode字符。 key不能为空。不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”,且首尾字符不能为空格。

value

String

值。每个值最大长度43个unicode字符,可以为空字符串。 不能包含“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”,且首尾字符不能为空格。

状态码: 400

表8 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表9 响应Body参数

参数

参数类型

描述

code

String

错误码

最小长度:8

最大长度:36

message

String

错误描述

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

查询PTR列表响应

{
  "links" : {
    "self" : "https://Endpoint/v2/reverse/floatingips",
    "next" : "https://Endpoint/v2/zones?id=&limit=10&marker=region_id:c5504932-bf23-4171-b655-b87a6bc59334"
  },
  "metadata" : {
    "total_count" : 1
  },
  "floatingips" : [ {
    "id" : "region_id:c5504932-bf23-4171-b655-b87a6bc59334",
    "ptrdname" : "www.example.com.",
    "description" : "Description for this PTR record",
    "address" : "10.154.52.138",
    "action" : "NONE",
    "ttl" : 300,
    "status" : "ACTIVE",
    "links" : {
      "self" : "https://Endpoint/v2/reverse/floatingips/region_id:c5504932-bf23-4171-b655-b87a6bc59334"
    }
  } ]
}

SDK代码示例

SDK代码示例如下。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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 ListPtrRecordsSolution {

    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("<YOUR REGION>"))
                .build();
        ListPtrRecordsRequest request = new ListPtrRecordsRequest();
        request.withMarker("<marker>");
        request.withLimit(<limit>);
        request.withOffset(<offset>);
        request.withEnterpriseProjectId("<enterprise_project_id>");
        request.withTags("<tags>");
        request.withStatus("<status>");
        try {
            ListPtrRecordsResponse response = client.listPtrRecords(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());
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# 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("<YOUR REGION>")) \
        .build()

    try:
        request = ListPtrRecordsRequest()
        request.marker = "<marker>"
        request.limit = <limit>
        request.offset = <offset>
        request.enterprise_project_id = "<enterprise_project_id>"
        request.tags = "<tags>"
        request.status = "<status>"
        response = client.list_ptr_records(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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 := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        Build()

    client := dns.NewDnsClient(
        dns.DnsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.ListPtrRecordsRequest{}
	markerRequest:= "<marker>"
	request.Marker = &markerRequest
	limitRequest:= int32(<limit>)
	request.Limit = &limitRequest
	offsetRequest:= int32(<offset>)
	request.Offset = &offsetRequest
	enterpriseProjectIdRequest:= "<enterprise_project_id>"
	request.EnterpriseProjectId = &enterpriseProjectIdRequest
	tagsRequest:= "<tags>"
	request.Tags = &tagsRequest
	statusRequest:= "<status>"
	request.Status = &statusRequest
	response, err := client.ListPtrRecords(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

查询PTR列表响应

400

接口错误响应。

500

接口错误响应。

错误码

请参见错误码

相关文档