GetMachineGroup-阿里云帮助中心

Retrieves the details of a specific machine group.

Note

This API has been deprecated. We recommend migrating to PaiStudio(2022-01-12) - GetMachineGroup for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

GET /api/v1/resources/machinegroups/{MachineGroupID} HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
MachineGroupID	string	Yes	The ID of the machine group.

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object	The returned data.
MachineGroupID	string	The ID of the machine group.
OrderID	string	The order ID.
PAIResourceID	string	The PAI resource ID.
Status	string	The status of the machine group.
PayType	string	The payment type. Valid values: `PostPay` (pay-as-you-go) and `PrePay` (subscription).
PricingCycle	string	The billing cycle. This parameter is returned only when `PayType` is `PrePay`.
Duration	string	The subscription duration. This parameter is returned only when `PayType` is `PrePay`.
EcsType	string	The ECS instance type of the machine group.
Count	integer	The number of instances in the machine group.
RegionID	string	The region ID.
GmtCreated	string	The time when the machine group was created.
GmtModified	string	The time when the machine group was last modified.
GmtStarted	string	The time when the machine group started.
GmtExpired	string	The expiration time. This parameter is returned only when `PayType` is `PrePay`.
RequestId	string	The request ID.
SupportedDrivers	array	The drivers that the machine group supports.
	string	The driver name.
DefaultDriver	string	The default driver.
OrderInstanceId	string	The instance ID of the order.

Examples

Success response

JSON format

{
  "MachineGroupID": "",
  "OrderID": "",
  "PAIResourceID": "",
  "Status": "",
  "PayType": "",
  "PricingCycle": "",
  "Duration": "",
  "EcsType": "",
  "Count": 0,
  "RegionID": "",
  "GmtCreated": "",
  "GmtModified": "",
  "GmtStarted": "",
  "GmtExpired": "",
  "RequestId": "",
  "SupportedDrivers": [
    ""
  ],
  "DefaultDriver": "",
  "OrderInstanceId": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.