Querying Name Servers in a Public Zone
Function
This API is used to query the name server information of a public zone after the public zone is created. The information includes the host name and priority.
Calling Method
For details, see Calling APIs.
URI
GET /v2/zones/{zone_id}/nameservers
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zone_id |
Yes |
String |
Definition Zone ID Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition The user token. The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token. For details about how to obtain a user token, seeObtaining a User Token. Constraints N/A Range N/A Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
nameservers |
Array of Nameserver objects |
Definition Response to the request for querying the name servers in a public zone Range N/A |
Parameter |
Type |
Description |
---|---|---|
hostname |
String |
Definition Host name Range N/A |
priority |
Integer |
Definition Priority Range N/A |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
code |
String |
Definition Error code Range N/A |
message |
String |
Definition Error description Range N/A |
Example Requests
Querying name servers in a public zone
GET https://{endpoint}/v2/zones/2c9eb155587194ec01587224c9f90149/nameservers
Example Responses
Status code: 200
Successful request
{ "nameservers" : [ { "hostname" : "ns1.example.com.", "priority" : 1 }, { "hostname" : "ns2.example.com.", "priority" : 2 } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
Successful request |
400 |
Error response |
404 |
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.