Queries vhosts.

Request parameters

Parameter Type Required Example Description
Action String Yes ListVirtualHosts

The operation that you want to perform.

Set the value to ListVirtualHosts.

InstanceId String Yes 1880770869023***

The ID of the instance.

MaxResults Integer Yes 2

The maximum number of result entries to return.

RegionId String Yes cn-hangzhou

The ID of the region.

NextToken String No ,

The token used to view data of the next page. This parameter is left empty for the first call.

Response parameters

Parameter Type Example Description
Data Struct

The returned data.

MaxResults Integer 2

The maximum number of returned result entries.

NextToken String ,

The token used to view data of the next page.

VirtualHosts Array of VhostVO

An array of vhosts.

Name String test

The name of the vhost.

RequestId String EF4DB019-DA4A-4CE3-B220-223BBC93F***

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListVirtualHosts
&InstanceId=1880770869023***
&MaxResults=2
&RegionId=cn-hangzhou
&<Common request parameters>

Sample success responses

XML format

<ListVirtualHostsResponse>
      <RequestId>EF4DB019-DA4A-4CE3-B220-223BBC93F***</RequestId>
      <Data>
            <NextToken>,</NextToken>
            <MaxResults>2</MaxResults>
            <VirtualHosts>
                  <Name>test</Name>
            </VirtualHosts>
      </Data>
</ListVirtualHostsResponse>

JSON format

{
    "RequestId":"EF4DB019-DA4A-4CE3-B220-223BBC93F***",
    "Data":{
        "NextToken":",",
        "MaxResults":"2",
        "VirtualHosts":[
            {
                "Name":"test"
            }
        ]
    }
}

Error codes

For a list of error codes, visit the API Error Center.