VM Related Interfaces

Get Virtual Machine DNS Information

GET/zstack/v1/vm-instances/{vmInstanceUuid}/dns

Headers

Authorization: OAuth the-session-uuid

Curl Example

curl -H "Content-Type: application/json;charset=UTF-8" \
-H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \
-X GET http://localhost:8080/zstack/v1/vm-instances/ff01ec80fd11327cba7519b66119d900/dns?vmNicUuid=ff06b3f6ce3939d78731832c5ac97000&ipVersion=4

Parameter List

Name

Type

Location

Description

Allowed Values

Starting Version

vmInstanceUuid

String

url

Virtual Machine UUID

 

4.10.10

vmNicUuid (Optional)

String

query

Virtual Machine NIC UUID

 

4.10.10

ipVersion (Optional)

Integer

query

IP Protocol Number

  • 4
  • 6

4.10.10

systemTags (Optional)

List

query

System Tag

 

4.10.10

userTags (Optional)

List

query

User Tag

 

4.10.10

API Response

Response Example

{
  "dnsList": [
    "8.8.8.8"
  ]
}
NameTypeDescriptionStarting Version
dnsListListDNS List4.10.10
successboolean 4.10.10
vmDnsListListFor details, see vmDnsList4.10.10
errorErrorCodeError code. If not null, the operation failed. When the operation is successful, this field is null. For details, see error4.10.10

vmDnsList

NameTypeDescriptionStarting Version
vmInstanceUuidStringVirtual Machine UUID4.10.10
vmNicUuidStringVirtual Machine NIC UUID4.10.10
dnsStringDNS Address4.10.10
ipVersionIntegerIP Protocol Number4.10.10
createDateTimestampCreate time4.10.10
lastOpDateTimestampLast modification time4.10.10

error

NameTypeDescriptionStarting Version
codeStringError code number, globally unique identifier of the error, for example SYS.1000, HOST.10010.6
descriptionStringBrief description of the error0.6
detailsStringDetailed error information0.6
elaborationStringReserved field, default is null0.6
opaqueLinkedHashMapReserved field, default is null0.6
causeErrorCodeRoot cause: the source error that triggered the current error. If there is no original error, this field is null0.6

SDK Examples

Java SDK

GetVmDnsAction action = new GetVmDnsAction();
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900";
action.vmNicUuid = "ff06b3f6ce3939d78731832c5ac97000";
action.ipVersion = 4;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
GetVmDnsAction.Result res = action.call();

Python SDK

GetVmDnsAction action = GetVmDnsAction()
action.vmInstanceUuid = "ff01ec80fd11327cba7519b66119d900"
action.vmNicUuid = "ff06b3f6ce3939d78731832c5ac97000"
action.ipVersion = 4
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
GetVmDnsAction.Result res = action.call()