This API attaches an existing extension disk to a server.
Use ListDisk to get a list of existing disks to attach.
This API can only be executed on physical servers, and on servers with RHEL-KVM or OVM for SPARC server virtualization software.
This API is executed asynchronously. After the API is successfully executed, the status of the L-Platform changes to Reconfiguring (RECONFIG_ING) during the execution of the operation, and changes back to Operating Normally (NORMAL) when the operation is completed. When the status of an L-Platform is Reconfiguring, the L-Platform cannot be operated. Use GetLPlatformStatus to check the status of the L-Platform, and execute subsequent operations after waiting for the status to change to Operating Normally.
It cannot be used in the following cases:
The target server is a server for which modification configurations or deletion cannot be performed.
For the servers for which configuration modification and deletion cannot be performed, refer to "8.3.18 L-Platform Reconfiguration" in the "User's Guide for Tenant Administrators CE".
Request parameters
Parameter name | Item | Item description |
|---|---|---|
Version | Description | The version ID of the L-Platform API. |
Type | string | |
Value | Fixed. Specify "2.0". | |
Locale | Description | The language for communicating with the L-Platform API. This parameter is specified using the language codes stipulated by ISO 639. |
Type | string | |
Value | Select one of the following: | |
Action | Description | The name of the L-Platform API to be executed. |
Type | string | |
Value | Fixed. Specify "AttachDisk". | |
userId | Description | The user ID of the user that executes the L-Platform API. |
Type | string | |
Value | No more than 31 characters. | |
orgId | Description | The tenant name of the user that executes the L-Platform API. |
Type | string | |
Value | No more than 32 characters. | |
lplatformId | Description | System ID |
Type | string | |
Value | No more than 32 characters. | |
lserverId | Description | Server ID |
Type | string | |
Value | No more than 32 characters. | |
diskResourceId | Description | The resource ID of the existing disk to be attached. |
Type | string | |
Value | No more than 32 characters. | |
diskName | Description | The name of the existing disk to be attached. |
Type | string | |
Value | No more than 85 characters. The name of an existing disk need not be specified. |
Response
<Status code>
The API returns "200 OK" if it terminates normally.
<XML>
<?xml version="1.0" encoding="UTF-8"?> <AttachDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <diskId>[Created disk ID]</diskId> <responseMessage>[Message]</responseMessage> <responseStatus>[Status]</responseStatus> </AttachDiskResponse>
<Elements>
Element name | Item | Item description |
|---|---|---|
AttachDiskResponse | Description | Element holding the response information. |
Type | None | |
Number of occurrences | 1 | |
diskId | Description | The ID of the disk created by this operation. |
Type | string | |
Number of occurrences | 0 or 1 | |
responseMessage | Description | Message. This element indicates whether the request has been processed correctly. |
Type | string | |
Number of occurrences | 1 | |
responseStatus | Description | Status. This element indicates whether the request has been processed normally. "SUCCESS" is returned if the request is processed normally. Otherwise, an error code is returned. |
Type | string | |
Number of occurrences | 1 |
Sample response
<?xml version="1.0" encoding="UTF-8"?> <AttachDiskResponse xmlns="http://cfmg.systemwalker.jp.fujitsu.com"> <diskId>tenantD-HY43YHSWA-D-0003</diskId> <responseMessage>PAPI00000 Processing was completed.</responseMessage> <responseStatus>SUCCESS</responseStatus> </AttachDiskResponse>
