OpenAPI metadata

{
    "code": 0,
    "data": {
        "methods": [
            "post",
            "get"
        ],
        "schemes": [
            "http",
            "https"
        ],
        "security": [
            {
                "AK": []
            }
        ],
        "deprecated": false,
        "systemTags": {
            "operationType": "get"
        },
        "parameters": [
            {
                "name": "RegionId",
                "in": "query",
                "schema": {
                    "description": "The region ID of the instance. You can call [DescribeRegions](~~25609~~) to view the latest list of Alibaba Cloud regions.",
                    "type": "string",
                    "required": true,
                    "example": "cn-hangzhou"
                }
            },
            {
                "name": "ZoneId",
                "in": "query",
                "schema": {
                    "description": "The zone ID of the instance. You can call [DescribeZones](~~25610~~) to view the latest list of Alibaba Cloud zones.",
                    "type": "string",
                    "required": false,
                    "example": "cn-hangzhou-d"
                }
            },
            {
                "name": "ClusterId",
                "in": "query",
                "schema": {
                    "description": "The cluster ID of the instance.\n\n><notice>This parameter is deprecated and not recommended for use!></notice>",
                    "type": "string",
                    "required": false,
                    "example": "cls-bp67acfmxazb4p****"
                }
            },
            {
                "name": "PageNumber",
                "in": "query",
                "schema": {
                    "description": "The page number of the instance status list.\n\nMinimum value: 1.\n\nDefault value: 1.",
                    "type": "integer",
                    "format": "int32",
                    "required": false,
                    "minimum": "1",
                    "example": "1",
                    "default": "1"
                }
            },
            {
                "name": "PageSize",
                "in": "query",
                "schema": {
                    "description": "The number of entries per page in paged queries. Valid values: 1 to 50.\n\nDefault value: 10.",
                    "type": "integer",
                    "format": "int32",
                    "required": false,
                    "maximum": "50",
                    "minimum": "1",
                    "example": "10",
                    "default": "10"
                }
            },
            {
                "name": "InstanceId",
                "in": "query",
                "style": "repeatList",
                "schema": {
                    "description": "An array of instance IDs. Array length: 1 to 100.\n\nExample: [\"i-bp1j4i2jdf3owlhe****\", \"i-bp1j4i2jdf3o1234****\"].",
                    "type": "array",
                    "items": {
                        "description": "The instance ID.",
                        "type": "string",
                        "required": false,
                        "example": "i-bp1j4i2jdf3owlhe****"
                    },
                    "required": false,
                    "example": "i-bp1j4i2jdf3owlhe****",
                    "maxItems": 100
                }
            }
        ],
        "responses": {
            "200": {
                "schema": {
                    "type": "object",
                    "properties": {
                        "PageSize": {
                            "description": "The number of entries per page specified in the request.",
                            "type": "integer",
                            "format": "int32",
                            "example": "1"
                        },
                        "RequestId": {
                            "description": "The request ID.",
                            "type": "string",
                            "example": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
                        },
                        "PageNumber": {
                            "description": "The page number of the instance list.",
                            "type": "integer",
                            "format": "int32",
                            "example": "1"
                        },
                        "TotalCount": {
                            "description": "The total number of instances.",
                            "type": "integer",
                            "format": "int32",
                            "example": "58"
                        },
                        "InstanceStatuses": {
                            "type": "object",
                            "itemNode": true,
                            "properties": {
                                "InstanceStatus": {
                                    "description": "A collection of instance IDs and their statuses.",
                                    "type": "array",
                                    "items": {
                                        "type": "object",
                                        "properties": {
                                            "Status": {
                                                "description": "The instance status. Valid values: \n\n- Pending: Creating.\n\n- Running: Running.\n\n- Starting: Starting.\n\n- Stopping: Stopping.\n\n- Stopped: Stopped.",
                                                "type": "string",
                                                "example": "Running"
                                            },
                                            "InstanceId": {
                                                "description": "The instance ID.",
                                                "type": "string",
                                                "example": "i-bp1j4i2jdf3owlhe****"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        },
        "errorCodes": {
            "403": [
                {
                    "errorCode": "InvalidParameter.TooManyInstanceIds",
                    "errorMessage": "Instance ids cannot be more than 100."
                },
                {
                    "errorCode": "Abs.InvalidInstanceIds.MalFormed",
                    "errorMessage": "The specified instanceIds is not valid."
                }
            ],
            "404": [
                {
                    "errorCode": "InvalidZoneId.NotFound",
                    "errorMessage": "The ZoneId provided does not exist in our records."
                }
            ]
        },
        "responseDemo": "[{\"type\":\"json\",\"example\":\"{\\n  \\\"PageSize\\\": 1,\\n  \\\"RequestId\\\": \\\"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E\\\",\\n  \\\"PageNumber\\\": 1,\\n  \\\"TotalCount\\\": 58,\\n  \\\"InstanceStatuses\\\": {\\n    \\\"InstanceStatus\\\": [\\n      {\\n        \\\"Status\\\": \\\"Running\\\",\\n        \\\"InstanceId\\\": \\\"i-bp1j4i2jdf3owlhe****\\\"\\n      }\\n    ]\\n  }\\n}\",\"errorExample\":\"{\\n\\\"RequestId\\\": \\\"6EF60BEC-0242-43AF-BB20-270359FB54A7\\\",\\n\\\"TotalCount\\\": 2,\\n\\\"PageNumber\\\": 1,\\n\\\"PageSize\\\": 10,\\n\\\"InstanceStatuses\\\": {\\n    \\\"InstanceStatus\\\": [{\\n        \\\"InstanceId\\\": \\\"i-instance1\\\",\\n            \\\"Status\\\": \\\"Running\\\"\\n        },\\n        {\\n            \\\"InstanceId\\\": \\\"i-ae4r89pp\\\",\\n            \\\"Status\\\": \\\"Stopped\\\"\\n        }]\\n    }\\n}\"},{\"type\":\"xml\",\"example\":\"<DescribeInstanceStatusResponse>\\n    <PageNumber>1</PageNumber>\\n    <InstanceStatuses>\\n        <InstanceStatus>\\n            <Status>Running</Status>\\n            <InstanceId>i-bp1j4i2jdf3owlhe****</InstanceId>\\n        </InstanceStatus>\\n    </InstanceStatuses>\\n    <TotalCount>58</TotalCount>\\n    <PageSize>1</PageSize>\\n    <RequestId>746C3444-9A24-4D7D-B8A8-DCBF7AC8BD66</RequestId>\\n</DescribeInstanceStatusResponse>\",\"errorExample\":\"<DescribeInstanceStatusResponse>\\n    <RequestId>6EF60BEC-0242-43AF-BB20-270359FB54A7</RequestId>\\n    <TotalCount>2</TotalCount>\\n    <PageNumber>1</PageNumber>\\n    <PageSize>10</PageSize>\\n    <InstanceStatuses>\\n        <InstanceStatus>\\n            <InstanceId>i-instance1</InstanceId>\\n                <Status>Running</Status>\\n            </InstanceStatus>\\n            <InstanceStatus>\\n                <InstanceId>i-ae4r89pp</InstanceId>\\n                <Status>Stopped</Status>\\n        </InstanceStatus>\\n    </InstanceStatuses>\\n</DescribeInstanceStatusResponse>\"}]",
        "title": "Query the list of instance status information",
        "summary": "This operation queries the status of one or more specified ECS instances and supports listing instances based on specific conditions.",
        "description": "For ECS instance lifecycle states, see [Instance status table](~~25687~~). \n\n## Request examples\n- Query instances and their status by **region**. Example request parameter:\n```\n\"RegionID\": \"cn-hangzhou\"\n```\n\n- Query instances and their status by **zone** within a **region**. Example request parameters:\n```\n\"RegionID\": \"cn-hangzhou\",\n\"ZoneID\": \"cn-hangzhou-a\"\n```\n\n- Query instance status by **region** and **instance ID**. Example request parameters:\n```\n\"RegionID\": \"cn-hangzhou\",\n\"InstancesID\": [\"i-bp1f7c1zqp999zvp****\", \"i-bp1dqjv36biueg61****\"]\n```",
        "requestParamsDescription": " ",
        "responseParamsDescription": " ",
        "extraInfo": " "
    }
}