1. Interface Description
Interface request domain name: cvm.api3.convergecloud.com.
This API is used to mount the ISO image to the instance.
Default interface request rate limit: 10 times per second.
Interface update time: 2025-08-05 01:09:49.
The interface is both signature verification and authentication.
2. Input Parameters
The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.
| Parameter name | Required | Allow NULL | Type | Description |
|---|---|---|---|---|
| Action | Yes | No | String | Public parameter, The value of this interface: InstanceAttachISO |
| Version | Yes | No | String | Public parameter, The value of this interface: 2017-03-12 |
| Region | No | No | String | Public parameter,Regional information A list of supported geographies is available through the DescribeRegions interface |
| InstanceId | Yes | No | String | ID of the instance for mounting the ISO image Example: ins-61dyt49h |
| ImageUrl | Yes | No | String | COS address where the ISO image is stored Example: http://111-1251533127.cosd.convergecloud.com/kiki/4769fxg.vmdk |
| Architecture | Yes | No | String | Operating system architecture of the ISO image: x86_64 or arm_64 Example: x86_64 |
| OsType | Yes | No | String | Operating system type of the ISO image Example: CentOS |
| OsVersion | Yes | No | String | Operating system version of the ISO image Example: 7.2.1 |
| DryRun | No | No | Bool | Check parameters only, do not execute task. Example: true |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| RequestId | String | Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem. |
4. Error Code
The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.
| Error Code | Description |
|---|---|
| InvalidImageOsVersion.Unsupported | Unsupported operating system version. |
| InvalidParameter.InvalidParameterUrlError | Incorrect URL address. |
| InvalidImageOsType.Unsupported | Unsupported operating system type. |
| InvalidInstanceId.NotFound | No corresponding instance was found. |