1# @ohos.file.volumeManager (Volume Management) 2 3The **volumeManager** module provides APIs for volume and disk management, including obtaining volume information, mounting or unmounting a volume, partitioning a disk, and formatting a volume. 4 5> **NOTE** 6> 7> - The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version. 8> - The APIs provided by this module are system APIs. 9 10## Modules to Import 11 12```js 13import volumemanager from "@ohos.file.volumeManager"; 14``` 15 16## volumemanager.getAllVolumes 17 18getAllVolumes(): Promise<Array<Volume>> 19 20Obtains information about all volumes of this external storage device. This API uses a promise to return the result. 21 22**Required permissions**: ohos.permission.STORAGE_MANAGER 23 24**System capability**: SystemCapability.FileManagement.StorageService.Volume 25 26**Return value** 27 28 | Type | Description | 29 | ---------------------------------- | -------------------------- | 30 | Promise<[Volume](#volume)[]> | Promise used to return information about all available volumes.| 31 32**Error codes** 33 34For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 35 36| ID| Error Message| 37| -------- | -------- | 38| 201 | Permission verification failed. | 39| 202 | The caller is not a system application. | 40| 401 | The input parameter is invalid. | 41| 13600001 | IPC error. | 42| 13900032 | Unknown error. | 43 44**Example** 45 46 ```js 47 import { BusinessError } from '@ohos.base'; 48 volumemanager.getAllVolumes().then((volumes: volumemanager.Volume) => { 49 // Do something. 50 }).catch((error: BusinessError) => { 51 console.info("getAllVolumes failed"); 52 }); 53 ``` 54 55## volumemanager.getAllVolumes 56 57getAllVolumes(callback: AsyncCallback<Array<Volume>>): void 58 59Obtains information about all volumes of this external storage device. This API uses an asynchronous callback to return the result. 60 61**Required permissions**: ohos.permission.STORAGE_MANAGER 62 63**System capability**: SystemCapability.FileManagement.StorageService.Volume 64 65**Parameters** 66 67 | Name | Type | Mandatory| Description | 68 | -------- | ------------------------------------------------- | ---- | ------------------------------------ | 69 | callback | AsyncCallback<[Volume](#volume)[]> | Yes | Callback invoked to return information about all available volumes.| 70 71**Error codes** 72 73For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 74 75| ID| Error Message| 76| -------- | -------- | 77| 201 | Permission verification failed. | 78| 202 | The caller is not a system application. | 79| 401 | The input parameter is invalid. | 80| 13600001 | IPC error. | 81| 13900032 | Unknown error. | 82 83**Example** 84 85 ```js 86 import { BusinessError } from '@ohos.base'; 87 let uuid: string = ""; 88 volumemanager.getAllVolumes((error: BusinessError, volumes: volumemanager.Volume) => { 89 // Do something. 90 }); 91 ``` 92 93## volumemanager.mount 94 95mount(volumeId: string): Promise<void> 96 97Asynchronously mounts a volume. This API uses a promise to return the result. Currently, only the File Allocation Table (FAT), Extensible FAT (exFAT), and New Technology File System (NTFS) file systems are supported. 98 99**Required permissions**: ohos.permission.MOUNT_UNMOUNT_MANAGER 100 101**System capability**: SystemCapability.FileManagement.StorageService.Volume 102 103**Parameters** 104 105 | Name | Type | Mandatory| Description| 106 | -------- | ------ | ---- | ---- | 107 | volumeId | string | Yes | Volume ID.| 108 109**Return value** 110 111 | Type | Description | 112 | ---------------------- | ---------- | 113 | Promise<void> | Promise that returns no value.| 114 115**Error codes** 116 117For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 118 119| ID| Error Message| 120| -------- | -------- | 121| 201 | Permission verification failed. | 122| 202 | The caller is not a system application. | 123| 401 | The input parameter is invalid. | 124| 13600001 | IPC error. | 125| 13600002 | Not supported filesystem. | 126| 13600003 | Failed to mount. | 127| 13600005 | Incorrect volume state. | 128| 13600008 | No such object. | 129| 13900032 | Unknown error. | 130 131**Example** 132 133 ```js 134 import { BusinessError } from '@ohos.base'; 135 let volumeId: string = ""; 136 volumemanager.mount(volumeId).then(() => { 137 // Do something. 138 }).catch((error: BusinessError) => { 139 console.info("mount failed"); 140 }); 141 ``` 142 143## volumemanager.mount 144 145mount(volumeId: string, callback:AsyncCallback<void>):void 146 147Asynchronously mounts a volume. This API uses an asynchronous callback to return the result. Currently, only the FAT, exFAT, and NTFS file systems are supported. 148 149**Required permissions**: ohos.permission.MOUNT_UNMOUNT_MANAGER 150 151**System capability**: SystemCapability.FileManagement.StorageService.Volume 152 153**Parameters** 154 155 | Name | Type | Mandatory| Description | 156 | -------- | ------------------------------------- | ---- | -------------------- | 157 | volumeId | string | Yes | Volume ID. | 158 | callback | AsyncCallback<void> | Yes | Callback that returns no value.| 159 160**Error codes** 161 162For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 163 164| ID| Error Message| 165| -------- | -------- | 166| 201 | Permission verification failed. | 167| 202 | The caller is not a system application. | 168| 401 | The input parameter is invalid. | 169| 13600001 | IPC error. | 170| 13600002 | Not supported filesystem. | 171| 13600003 | Failed to mount. | 172| 13600005 | Incorrect volume state. | 173| 13600008 | No such object. | 174| 13900032 | Unknown error. | 175 176**Example** 177 178 ```js 179 import { BusinessError } from '@ohos.base'; 180 let volumeId: string = ""; 181 volumemanager.mount(volumeId, (error: BusinessError) => { 182 // Do something. 183 }); 184 ``` 185 186## volumemanager.unmount 187 188unmount(volumeId: string): Promise<void> 189 190Asynchronously unmounts a volume. This API uses a promise to return the result. 191 192**Required permissions**: ohos.permission.MOUNT_UNMOUNT_MANAGER 193 194**System capability**: SystemCapability.FileManagement.StorageService.Volume 195 196**Parameters** 197 198 | Name | Type | Mandatory| Description| 199 | -------- | ------ | ---- | ---- | 200 | volumeId | string | Yes | Volume ID.| 201 202**Return value** 203 204 | Type | Description | 205 | ---------------------- | ---------- | 206 | Promise<void> | Promise that returns no value.| 207 208**Error codes** 209 210For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 211 212| ID| Error Message| 213| -------- | -------- | 214| 201 | Permission verification failed. | 215| 202 | The caller is not a system application. | 216| 401 | The input parameter is invalid. | 217| 13600001 | IPC error. | 218| 13600002 | Not supported filesystem. | 219| 13600004 | Failed to unmount. | 220| 13600005 | Incorrect volume state. | 221| 13600008 | No such object. | 222| 13900032 | Unknown error. | 223 224**Example** 225 226 ```js 227 import { BusinessError } from '@ohos.base'; 228 let volumeId: string = ""; 229 volumemanager.unmount(volumeId).then(() => { 230 // Do something. 231 }).catch((error: BusinessError) => { 232 console.info("mount failed"); 233 }); 234 ``` 235 236## volumemanager.unmount 237 238unmount(volumeId: string, callback: AsyncCallback<void>): void 239 240Asynchronously unmounts a volume. This API uses an asynchronous callback to return the result. 241 242**Required permissions**: ohos.permission.MOUNT_UNMOUNT_MANAGER 243 244**System capability**: SystemCapability.FileManagement.StorageService.Volume 245 246**Parameters** 247 248 | Name | Type | Mandatory| Description | 249 | -------- | ------------------------------------- | ---- | -------------------- | 250 | volumeId | string | Yes | Volume ID. | 251 | callback | AsyncCallback<void> | Yes | Callback that returns no value.| 252 253**Error codes** 254 255For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 256 257| ID| Error Message| 258| -------- | -------- | 259| 201 | Permission verification failed. | 260| 202 | The caller is not a system application. | 261| 401 | The input parameter is invalid. | 262| 13600001 | IPC error. | 263| 13600002 | Not supported filesystem. | 264| 13600004 | Failed to unmount. | 265| 13600005 | Incorrect volume state. | 266| 13600008 | No such object. | 267| 13900032 | Unknown error. | 268 269**Example** 270 271 ```js 272 import { BusinessError } from '@ohos.base'; 273 let volumeId: string = ""; 274 volumemanager.unmount(volumeId, (error: BusinessError) => { 275 // Do something. 276 }); 277 ``` 278 279## volumemanager.getVolumeByUuid 280 281getVolumeByUuid(uuid: string): Promise<Volume> 282 283Obtains information about a volume based on the universally unique identifier (UUID). This API uses a promise to return the result. 284 285**Required permissions**: ohos.permission.STORAGE_MANAGER 286 287**System capability**: SystemCapability.FileManagement.StorageService.Volume 288 289**Parameters** 290 291 | Name | Type | Mandatory| Description| 292 | -------- | ------ | ---- | ---- | 293 | uuid | string | Yes | UUID of the volume.| 294 295**Return value** 296 297 | Type | Description | 298 | ---------------------------------- | -------------------------- | 299 | Promise<[Volume](#volume)> | Promise used to return the volume information obtained.| 300 301**Error codes** 302 303For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 304 305| ID| Error Message| 306| -------- | -------- | 307| 201 | Permission verification failed. | 308| 202 | The caller is not a system application. | 309| 401 | The input parameter is invalid. | 310| 13600001 | IPC error. | 311| 13600008 | No such object. | 312| 13900032 | Unknown error. | 313 314**Example** 315 316 ```js 317 import { BusinessError } from '@ohos.base'; 318 let uuid: string = ""; 319 volumemanager.getVolumeByUuid(uuid).then((volume: volumemanager.Volume) => { 320 console.info("getVolumeByUuid successfully:" + JSON.stringify(volume)); 321 }).catch((error: BusinessError) => { 322 console.info("getVolumeByUuid failed with error:"+ error); 323 }); 324 ``` 325 326## volumemanager.getVolumeByUuid 327 328getVolumeByUuid(uuid: string, callback: AsyncCallback<Volume>): void 329 330Obtains information about a volume based on the UUID. This API uses an asynchronous callback to return the result. 331 332**Required permissions**: ohos.permission.STORAGE_MANAGER 333 334**System capability**: SystemCapability.FileManagement.StorageService.Volume 335 336**Parameters** 337 338 | Name | Type | Mandatory| Description | 339 | -------- | ------------------------------------------------ | ---- | -------------------- | 340 | uuid | string | Yes | UUID of the volume. | 341 | callback | AsyncCallback<[Volume](#volume)> | Yes | Callback invoked to return the volume information obtained.| 342 343**Error codes** 344 345For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 346 347| ID| Error Message| 348| -------- | -------- | 349| 201 | Permission verification failed. | 350| 202 | The caller is not a system application. | 351| 401 | The input parameter is invalid. | 352| 13600001 | IPC error. | 353| 13600008 | No such object. | 354| 13900032 | Unknown error. | 355 356**Example** 357 358 ```js 359 import { BusinessError } from '@ohos.base'; 360 let uuid: string = ""; 361 volumemanager.getVolumeByUuid(uuid, (error: BusinessError, volume: volumemanager.Volume) => { 362 // Do something. 363 }); 364 ``` 365 366## volumemanager.getVolumeById 367 368getVolumeById(volumeId: string): Promise<Volume> 369 370Obtains information about a volume based on the volume ID. This API uses a promise to return the result. 371 372**Required permissions**: ohos.permission.STORAGE_MANAGER 373 374**System capability**: SystemCapability.FileManagement.StorageService.Volume 375 376**Parameters** 377 378 | Name | Type | Mandatory | Description| 379 | -------- | ------ | ---- | ---- | 380 | volumeId | string | Yes | Volume ID.| 381 382**Return value** 383 384 | Type | Description | 385 | ---------------------------------- | -------------------------- | 386 | Promise<[Volume](#volume)> | Promise used to return the volume information obtained.| 387 388**Error codes** 389 390For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 391 392| ID| Error Message| 393| -------- | -------- | 394| 201 | Permission verification failed. | 395| 202 | The caller is not a system application. | 396| 401 | The input parameter is invalid. | 397| 13600001 | IPC error. | 398| 13600008 | No such object. | 399| 13900032 | Unknown error. | 400 401**Example** 402 403 ```js 404 let volumeId: string = ""; 405 volumemanager.getVolumeById(volumeId).then((volume: volumemanager.Volume) => { 406 console.info("getVolumeById successfully:" + JSON.stringify(volume)); 407 }).catch((error: BusinessError) => { 408 console.info("getVolumeById failed with error:"+ error); 409 }); 410 ``` 411 412## volumemanager.getVolumeById 413 414getVolumeById(volumeId: string, callback: AsyncCallback<Volume>): void 415 416Obtains information about a volume based on the volume ID. This API uses an asynchronous callback to return the result. 417 418**Required permissions**: ohos.permission.STORAGE_MANAGER 419 420**System capability**: SystemCapability.FileManagement.StorageService.Volume 421 422**Parameters** 423 424 | Name | Type | Mandatory| Description | 425 | -------- | ------------------------- | ---- | ----------------------------- | 426 | volumeId | string | Yes | Volume ID. | 427 | callback | AsyncCallback<[Volume](#volume)> | Yes | Callback invoked to return the volume information obtained. | 428 429**Error codes** 430 431For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 432 433| ID| Error Message| 434| -------- | -------- | 435| 201 | Permission verification failed. | 436| 202 | The caller is not a system application. | 437| 401 | The input parameter is invalid. | 438| 13600001 | IPC error. | 439| 13600008 | No such object. | 440| 13900032 | Unknown error. | 441 442**Example** 443 444 ```js 445 import { BusinessError } from '@ohos.base'; 446 let volumeId: string = ""; 447 volumemanager.getVolumeById(volumeId, (error: BusinessError, volume: volumemanager.Volume) => { 448 // Do something. 449 }); 450 ``` 451 452## volumemanager.setVolumeDescription 453 454setVolumeDescription(uuid: string, description: string): Promise<void> 455 456Sets volume description. This API uses a promise to return the result. 457 458**Required permissions**: ohos.permission.MOUNT_UNMOUNT_MANAGER 459 460**System capability**: SystemCapability.FileManagement.StorageService.Volume 461 462**Parameters** 463 464 | Name | Type | Mandatory| Description| 465 | --------- | ------ | ---- | ---- | 466 | uuid | string | Yes | UUID of the volume.| 467 | description | string | Yes | Volume description to set.| 468 469**Return value** 470 471 | Type | Description | 472 | ---------------------- | -------------------------- | 473 | Promise<void> | Promise that returns no value. | 474 475**Error codes** 476 477For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 478 479| ID| Error Message| 480| -------- | -------- | 481| 201 | Permission verification failed. | 482| 202 | The caller is not a system application. | 483| 401 | The input parameter is invalid. | 484| 13600001 | IPC error. | 485| 13600002 | Not supported filesystem. | 486| 13600005 | Incorrect volume state. | 487| 13600008 | No such object. | 488| 13900032 | Unknown error. | 489 490**Example** 491 492 ```js 493 import { BusinessError } from '@ohos.base'; 494 let uuid: string = ""; 495 let description: string = ""; 496 volumemanager.setVolumeDescription(uuid, description).then(() => { 497 console.info("setVolumeDescription successfully"); 498 }).catch((error: BusinessError) => { 499 console.info("setVolumeDescription failed with error:"+ error); 500 }); 501 ``` 502 503## volumemanager.setVolumeDescription 504 505setVolumeDescription(uuid: string, description: string, callback: AsyncCallback<void>): void 506 507Sets volume description. This API uses an asynchronous callback to return the result. 508 509**Required permissions**: ohos.permission.MOUNT_UNMOUNT_MANAGER 510 511**System capability**: SystemCapability.FileManagement.StorageService.Volume 512 513**Parameters** 514 515 | Name | Type | Mandatory| Description | 516 | ---------- | --------------------------------------- | ---- | ---------------- | 517 | uuid | string | Yes | UUID of the volume. | 518 | description | string | Yes | Volume description to set. | 519 | callback | AsyncCallback<void> | Yes | Callback that returns no value.| 520 521**Error codes** 522 523For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 524 525| ID| Error Message| 526| -------- | -------- | 527| 201 | Permission verification failed. | 528| 202 | The caller is not a system application. | 529| 401 | The input parameter is invalid. | 530| 13600001 | IPC error. | 531| 13600002 | Not supported filesystem. | 532| 13600005 | Incorrect volume state. | 533| 13600008 | No such object. | 534| 13900032 | Unknown error. | 535 536**Example** 537 538 ```js 539 import { BusinessError } from '@ohos.base'; 540 let uuid: string = ""; 541 let description: string = ""; 542 volumemanager.setVolumeDescription(uuid, description, (error: BusinessError) => { 543 // Do something. 544 }); 545 ``` 546 547## volumemanager.format 548 549format(volumeId: string, fsType: string): Promise<void> 550 551Formats a volume. This API uses a promise to return the result. Currently, only the virtual file allocation table (VFAT) and exFAT file systems are supported. Only unmounted volumes can be formatted. After a volume is formatted, the UUID, mounting path, and description of the volume change. 552 553**Required permissions**: ohos.permission.MOUNT_FORMAT_MANAGER 554 555**System capability**: SystemCapability.FileManagement.StorageService.Volume 556 557**Parameters** 558 559 | Name | Type | Mandatory| Description| 560 | ----------- | ------ | ---- | ---- | 561 | volumeId | string | Yes | Volume ID.| 562 | fsType | string | Yes | File system type, which can be VFAT or exFAT.| 563 564**Return value** 565 566 | Type | Description | 567 | ---------------------- | ---------- | 568 | Promise<void> | Promise that returns no value.| 569 570**Error codes** 571 572For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 573 574| ID| Error Message| 575| -------- | -------- | 576| 201 | Permission verification failed. | 577| 202 | The caller is not a system application. | 578| 401 | The input parameter is invalid. | 579| 13600001 | IPC error. | 580| 13600002 | Not supported filesystem. | 581| 13600005 | Incorrect volume state. | 582| 13600008 | No such object. | 583| 13900032 | Unknown error. | 584 585**Example** 586 587 ```js 588 import { BusinessError } from '@ohos.base'; 589 let volumeId: string = ""; 590 let fsType: string = ""; 591 volumemanager.format(volumeId, fsType).then(() => { 592 console.info("format successfully"); 593 }).catch((error: BusinessError) => { 594 console.info("format failed with error:"+ error); 595 }); 596 ``` 597 598## volumemanager.format 599 600format(volumeId: string, fsType: string, callback: AsyncCallback<void>): void 601 602Formats a volume. This API uses an asynchronous callback to return the result. Currently, only the VFAT and exFAT file systems are supported. Only unmounted volumes can be formatted. After a volume is formatted, the UUID, mounting path, and description of the volume change. 603 604**Required permissions**: ohos.permission.MOUNT_FORMAT_MANAGER 605 606**System capability**: SystemCapability.FileManagement.StorageService.Volume 607 608**Parameters** 609 610 | Name | Type | Mandatory| Description | 611 | -------- | ------------------------- | ---- | ----------------------------- | 612 | volumeId | string | Yes | Volume ID. | 613 | fsType | string | Yes | File system type, which can be VFAT or exFAT.| 614 | callback | AsyncCallback<void> | Yes | Callback that returns no value. | 615 616**Error codes** 617 618For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 619 620| ID| Error Message| 621| -------- | -------- | 622| 201 | Permission verification failed. | 623| 202 | The caller is not a system application. | 624| 401 | The input parameter is invalid. | 625| 13600001 | IPC error. | 626| 13600002 | Not supported filesystem. | 627| 13600005 | Incorrect volume state. | 628| 13600008 | No such object. | 629| 13900032 | Unknown error. | 630 631**Example** 632 633 ```js 634 import { BusinessError } from '@ohos.base'; 635 let volumeId: string = ""; 636 let fsType: string = ""; 637 volumemanager.format(volumeId, fsType, (error: BusinessError) => { 638 // Do something. 639 }); 640 ``` 641 642## volumemanager.partition 643 644partition(diskId: string, type: number): Promise<void> 645 646Partitions a disk. This API uses a promise to return the result. The system supports access to multi-partition disks. Currently, this API can partition a disk into only one partition. 647 648**Required permissions**: ohos.permission.MOUNT_FORMAT_MANAGER 649 650**System capability**: SystemCapability.FileManagement.StorageService.Volume 651 652**Parameters** 653 654 | Name | Type | Mandatory| Description| 655 | ----------- | ------ | ---- | ---- | 656 | diskId | string | Yes | ID of the disk to partition.| 657 | type | number | Yes | Partition type. | 658 659**Return value** 660 661 | Type | Description | 662 | --------------------- | ----------------------- | 663 | Promise<void> | Promise that returns no value. | 664 665**Error codes** 666 667For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 668 669| ID| Error Message| 670| -------- | -------- | 671| 201 | Permission verification failed. | 672| 202 | The caller is not a system application. | 673| 401 | The input parameter is invalid. | 674| 13600001 | IPC error. | 675| 13600008 | No such object. | 676| 13900032 | Unknown error. | 677 678**Example** 679 680 ```js 681 import { BusinessError } from '@ohos.base'; 682 let diskId: string = ""; 683 let type: number = 0; 684 volumemanager.partition(diskId, type).then(() => { 685 console.info("partition successfully"); 686 }).catch((error: BusinessError) => { 687 console.info("partition failed with error:"+ error); 688 }); 689 ``` 690 691## volumemanager.partition 692 693partition(diskId: string, type: number, callback: AsyncCallback<void>): void 694 695Asynchronously partitions a disk. This API uses a callback to return the result. The system supports access to multi-partition disks. Currently, this API can partition a disk into only one partition. 696 697**Required permissions**: ohos.permission.MOUNT_FORMAT_MANAGER 698 699**System capability**: SystemCapability.FileManagement.StorageService.Volume 700 701**Parameters** 702 703 | Name | Type | Mandatory| Description | 704 | -------- | --------------------------------------- | ---- | ---------------- | 705 | diskId | string | Yes | ID of the disk to partition. | 706 | type | number | Yes | Partition type. | 707 | callback | AsyncCallback<void> | Yes | Callback that returns no value. | 708 709**Error codes** 710 711For details about the error codes, see [File Management Error Codes](../errorcodes/errorcode-filemanagement.md). 712 713| ID| Error Message| 714| -------- | -------- | 715| 201 | Permission verification failed. | 716| 202 | The caller is not a system application. | 717| 401 | The input parameter is invalid. | 718| 13600001 | IPC error. | 719| 13600008 | No such object. | 720| 13900032 | Unknown error. | 721 722**Example** 723 724 ```js 725 import { BusinessError } from '@ohos.base'; 726 let diskId: string = ""; 727 let type: number = 0; 728 volumemanager.partition(diskId, type, (error: BusinessError) => { 729 // Do something. 730 }); 731 ``` 732 733## Volume 734 735**System capability**: SystemCapability.FileManagement.StorageService.Volume 736 737### Attributes 738 739| Name | Type | Readable | Writable | Description | 740| ----------- | ------- | ------- | ----- | -------------------- | 741| id | string | Yes| No| Volume ID, in the vol-{Primary device ID}-{Secondary device ID} format. The primary device IDs identify devices of different types. The secondary device IDs identify different devices of the same type. The volume IDs vary depending on the card insertion sequence. | 742| uuid | string | Yes| No| Volume UUID, which uniquely identifies a volume irrespective of the card insertion sequence. However, the UUID of a volume will change after the volume is formatted. | 743| diskId | string | Yes| No| ID of the disk to which the volume belongs. A disk can have one or more volumes. The disk ID is in the disk-{Primary device ID}-{Secondary device ID} format, which is similar to the volume ID. | 744| description | string | Yes| No| Description of the volume. | 745| removable | boolean | Yes| No| Whether the volume can be removed. Currently, only removable storage devices are supported.| 746| state | number | Yes| No| Volume status.<br>**0**: The volume is unmounted.<br> **1**: The volume is being checked.<br> **2**: The volume is mounted.<br> **3**: The volume is being ejected. | 747| path | string | Yes| No| Path of the volume mounted. Generally, the path is **/mnt/external/{uuid}**. | 748