Queries the virtual machines (VMs) that are added to an Alibaba Cloud Service Mesh (ASM) instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
ServiceMeshId String Yes ccb37ff104caf419fbf48fb38e6f3****

The ID of the ASM instance.
Action String Yes DescribeVMsInServiceMesh

The operation that you want to perform. Set the value to DescribeVMsInServiceMesh.

Response parameters

Parameter Type Example Description
RequestId String 4b2c0fe0-6705-4614-8521-6b9d289163c8

The ID of the request.
VMs Array of VMs

The VMs that are added to the ASM instance.
InstanceId String i-2ze45cgxkx4q12e****

The ID of the VM.
HasTag Boolean true

Indicates whether the VM has labels.
IpAddress String 10.0.*,***

The IP address of the VM.
HostName String iZ2ze45cgxkx4q12eh9l****

The host name of the VM.
Status String Running

The status of the VM.
SecurityGroupIds String sg-2zeaqy08amco9osl****

The security group to which the VM belongs.
Region String cn-beijing

The region ID.

Examples

Sample requests

http(s)://[Endpoint]/?ServiceMeshId=ccb37ff104caf419fbf48fb38e6f3****
&Action=DescribeVMsInServiceMesh
&<Common request parameters>

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeVMsInServiceMeshResponse>
    <RequestId>4b2c0fe0-6705-4614-8521-6b9d289163c8</RequestId>
    <VMs>
        <InstanceId>i-2ze45cgxkx4q12e****</InstanceId>
        <HasTag>true</HasTag>
        <IpAddress>10.0.*,***</IpAddress>
        <HostName>iZ2ze45cgxkx4q12eh9l****</HostName>
        <Status>Running</Status>
        <SecurityGroupIds>sg-2zeaqy08amco9osl****</SecurityGroupIds>
        <Region>cn-beijing</Region>
    </VMs>
</DescribeVMsInServiceMeshResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "4b2c0fe0-6705-4614-8521-6b9d289163c8",
  "VMs" : {
    "InstanceId" : "i-2ze45cgxkx4q12e****",
    "HasTag" : true,
    "IpAddress" : "10.0.*,***",
    "HostName" : "iZ2ze45cgxkx4q12eh9l****",
    "Status" : "Running",
    "SecurityGroupIds" : "sg-2zeaqy08amco9osl****",
    "Region" : "cn-beijing"
  }
}

Error codes

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