Querying PTR Records
Function
This API is used to query all the PTR records.
Calling Method
For details, see Calling APIs.
URI
GET /v2/reverse/floatingips
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
marker |
No |
String |
Start resource ID of pagination query. If the parameter is left blank, only resources on the first page are queried. It is left blank by default. |
limit |
No |
Integer |
Number of resources on each page. The value ranges from 0 to 500. Commonly used values are 10, 20, and 50. The default value is 500. |
offset |
No |
Integer |
Start offset of pagination query. The query will start from the next resource of the offset value. The value ranges from 0 to 2147483647. The default value is 0. If marker is not left blank, the query starts from the resource specified by marker. |
enterprise_project_id |
No |
String |
ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. Default value: 0 |
tags |
No |
String |
Resource tag. The format is as follows: key1,value1|key2,value2. Multiple tags are separated by vertical bar (|). The key and value of each tag are separated by comma (,). |
status |
No |
String |
Resource status |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
links |
pageLink object |
Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. |
metadata |
metadata object |
Number of resources that meet the query condition |
floatingips |
Array of ListPtrRecordsFloatingResp objects |
PTR record ID list of an EIP |
Parameter |
Type |
Description |
---|---|---|
total_count |
Integer |
Number of resources that meet the filter criteria. The number is irrelevant to limit or offset. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
PTR record ID, which is in {region}:{floatingip_id} format |
ptrdname |
String |
Domain name of the PTR record |
description |
String |
PTR record description |
ttl |
Integer |
PTR record caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. |
address |
String |
EIP |
status |
String |
Resource status |
action |
String |
Requested operation on the resource.Value options: CREATE, UPDATE, DELETE, NONE, CREATE, UPDATE, and DELETE****NONE: No operation will be performed. |
links |
pageLink object |
Link of the current resource or other related resources. When a response is broken into pages, a next link is provided to retrieve all results. |
tags |
Array of tag objects |
Resource tag |
enterprise_project_id |
String |
ID of the enterprise project associated with the PTR record. The value contains a maximum of 36 characters. |
Parameter |
Type |
Description |
---|---|---|
self |
String |
Link to the current resource |
next |
String |
Link to the next page |
Parameter |
Type |
Description |
---|---|---|
key |
String |
Tag key. A key can contain up to 36 Unicode characters. It cannot be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces. |
value |
String |
Tag value. A tag value contains a maximum of 43 Unicode characters and can be left blank. A tag value cannot contain special characters (=*<>,|/) or start or end with spaces. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Error code Minimum: 8 Maximum: 36 |
message |
String |
Description Minimum: 2 Maximum: 512 |
Example Requests
None
Example Responses
Status code: 200
Response to the request for querying the PTR record list
{ "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 Sample Code
The SDK sample code is as follows.
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 |
# coding: utf-8 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 = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("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) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying the PTR record list |
400 |
Error response |
500 |
Error response |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot