Querying a Record Set
Function
This API is used to query a record set. This API applies only to public zones.
Calling Method
For details, see Calling APIs.
URI
GET /v2.1/zones/{zone_id}/recordsets/{recordset_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
zone_id |
Yes |
String |
Zone ID |
recordset_id |
Yes |
String |
ID of the record set to be queried |
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 |
---|---|---|
id |
String |
Record set ID |
name |
String |
Record set name |
description |
String |
Record set description |
zone_id |
String |
Zone ID of the record set |
zone_name |
String |
Zone name of the record set |
type |
String |
Record set type |
ttl |
Integer |
Record set caching duration (in seconds) on a local DNS server. The longer the duration is, the slower the update takes effect. |
records |
Array of strings |
Record set value |
created_at |
String |
Time when the record set was created |
updated_at |
String |
Time when the record set was updated |
status |
String |
Resource status |
default |
Boolean |
Whether the record set is generated by the system. A system-generated record set cannot be deleted. |
project_id |
String |
Project ID of the record set |
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. |
line |
String |
Resolution line ID |
weight |
Integer |
Weight of the record set |
health_check_id |
String |
Health check ID |
alias_target |
alias_target object |
Domain name alias |
bundle |
String |
Specification, which is the default specification. This field is reserved. |
Example Requests
None
Example Responses
Status code: 200
Response to the request for querying a record set
{ "id" : "2c9eb155587228570158722b6ac30007", "name" : "www.example.com.", "description" : "This is an example record set.", "type" : "A", "ttl" : 300, "records" : [ "192.168.10.2", "192.168.10.1" ], "status" : "ACTIVE", "links" : { "self" : "https://Endpoint/v2.1/zones/2c9eb155587194ec01587224c9f90149/recordsets/2c9eb155587228570158722b6ac30007" }, "alias_target" : null, "zone_id" : "2c9eb155587194ec01587224c9f90149", "zone_name" : "example.com.", "created_at" : "2016-11-17T12:03:17.827", "updated_at" : "2016-11-17T12:56:03.827", "default" : false, "project_id" : "e55c6f3dc4e34c9f86353b664ae0e70c", "line" : "default_view", "weight" : 1, "health_check_id" : null, "bundle" : "free" }
Status Codes
Status Code |
Description |
---|---|
200 |
Response to the request for querying a record set |
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.