Ctyun CTECS Java SDK

https://github.com/yangpp6/sdk-java-ctecs
Admin
A Java SDK for interacting with Ctyun (China Telecom Cloud) Elastic Cloud Compute Service (CTECS)...
Tokens:584,778
Snippets:2,527
Trust Score:2.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start Instance API

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

API for starting an instance, including request and response details.

```APIDOC
## Start Instance API

### Description
This API is used to start a cloud instance. It provides the structures for requests and responses.

### Endpoints
- `StartInstanceExample`
- `StartInstanceRequest`
- `StartInstanceRequestBody`
- `StartInstanceResponseData`
- `StartInstanceReturnObj`
```

--------------------------------

### EcsBatchStartExample

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-noframe.html

Example class for performing batch start operations on ECS instances.

```java
cn.ctyun.ctapi.ctecs.ecsbatchstart.EcsBatchStartExample
```

--------------------------------

### Batch Start Instance API

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-noframe.html

API for batch starting multiple instances simultaneously.

```APIDOC
## BatchStartInstance

### Description
Enables the batch starting of multiple instances.

### Method
POST

### Endpoint
/api/ctecs/instances/batch/start

### Parameters
#### Request Body
- **jobIdList** (array) - Required - List of job IDs to process for starting.

### Request Example
```json
{
  "jobIdList": ["job-xxxxxxxxxxxxxxxxx", "job-yyyyyyyyyyyyyyyyy"]
}
```

### Response
#### Success Response (200)
- **returnObj** (object) - Contains details about the start operation.
  - **jobId** (string) - The ID of the batch start job.

#### Response Example
```json
{
  "returnObj": {
    "jobId": "job-zzzzzzzzzzzzzzzzz"
  }
}
```
```

--------------------------------

### EcsPortsUnassignIpv6 Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsportsunassignipv6/EcsPortsUnassignIpv6Example.html

Example class for demonstrating EcsPortsUnassignIpv6 functionality.

```APIDOC
## EcsPortsUnassignIpv6Example

### Description
This class serves as an example for the EcsPortsUnassignIpv6 functionality.

### Methods

#### main

```java
public static void main(String[] args)
```

**Description:** The entry point of the example application.

#### run

```java
public static String run(String ak, String sk, String endingPoint)
```

**Description:** Executes the EcsPortsUnassignIpv6 operation.

**Parameters:**
- **ak** (String) - Required - Access key.
- **sk** (String) - Required - Secret access key.
- **endingPoint** (String) - Required - The endpoint for the API call.
```

--------------------------------

### EcsBackupCreate Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class for creating ECS backups. It demonstrates how to set up the request with block device mappings and other necessary details.

```java
package cn.ctyun.ctapi.ctecs.ecsbackupcreate;

import cn.ctyun.ctapi.ctecs.ecsbackupcreate.EcsBackupCreateBlockDeviceMappingS;
import cn.ctyun.ctapi.ctecs.ecsbackupcreate.EcsBackupCreateRequestBody;
import cn.ctyun.ctapi.ctecs.ecsbackupcreate.EcsBackupCreateResponseData;
import cn.ctyun.ctapi.ctecs.ecsbackupcreate.EcsBackupCreateRequest;
import cn.ctyun.ctapi.ctecs.ecsbackupcreate.EcsBackupCreateReturnObj;

public class EcsBackupCreateExample {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /**
     * EcsBackupCreate Example
     * @param ecsId
     * @param backupName
     * @param blockDeviceMappingS
     * @return
     */
    public EcsBackupCreateResponseData ecsBackupCreate(String ecsId, String backupName, EcsBackupCreateBlockDeviceMappingS[] blockDeviceMappingS) {
        EcsBackupCreateRequest request = new EcsBackupCreateRequest();
        request.setEcsId(ecsId);
        request.setBackupName(backupName);
        request.setBlockDeviceMappingS(blockDeviceMappingS);
        EcsBackupCreateResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupCreate Example
     * @param requestBody
     * @return
     */
    public EcsBackupCreateResponseData ecsBackupCreate(EcsBackupCreateRequestBody requestBody) {
        EcsBackupCreateRequest request = new EcsBackupCreateRequest();
        request.setRequestBody(requestBody);
        EcsBackupCreateResponseData response = request.customize();
        return response;
    }
}
```

--------------------------------

### ECS SFS Attach Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class demonstrating how to attach an SFS (Scalable File System) to an ECS instance. Use this as a guide for SFS attachment.

```java
cn.ctyun.ctapi.ctecs.ecssfsattach.EcsSfsAttachExample
```

--------------------------------

### POST /ecsStart

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/CtecsClient.html

Starts a cloud host instance.

```APIDOC
## POST /ecsStart

### Description
Provides functionality to start a cloud host.

### Parameters
#### Request Body
- **request** (EcsStartRequest) - Required - The request object containing host identification.
```

--------------------------------

### EcsBackupList Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class for listing ECS backups. It supports filtering and pagination through request parameters.

```java
package cn.ctyun.ctapi.ctecs.ecsbackuplist;

import cn.ctyun.ctapi.ctecs.ecsbackuplist.EcsBackupListBlockDeviceMappingS;
import cn.ctyun.ctapi.ctecs.ecsbackuplist.EcsBackupListRequestBody;
import cn.ctyun.ctapi.ctecs.ecsbackuplist.EcsBackupListResponseData;
import cn.ctyun.ctapi.ctecs.ecsbackuplist.EcsBackupListRequest;
import cn.ctyun.ctapi.ctecs.ecsbackuplist.EcsBackupListResults;
import cn.ctyun.ctapi.ctecs.ecsbackuplist.EcsBackupListReturnObj;

public class EcsBackupListExample {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /**
     * EcsBackupList Example
     * @param ecsId
     * @param page
     * @param pageSize
     * @return
     */
    public EcsBackupListResponseData ecsBackupList(String ecsId, Integer page, Integer pageSize) {
        EcsBackupListRequest request = new EcsBackupListRequest();
        request.setEcsId(ecsId);
        request.setPage(page);
        request.setPageSize(pageSize);
        EcsBackupListResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupList Example
     * @param requestBody
     * @return
     */
    public EcsBackupListResponseData ecsBackupList(EcsBackupListRequestBody requestBody) {
        EcsBackupListRequest request = new EcsBackupListRequest();
        request.setRequestBody(requestBody);
        EcsBackupListResponseData response = request.customize();
        return response;
    }
}
```

--------------------------------

### ECS SFS List Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class demonstrating how to list SFS details for ECS instances. Use this as a guide for querying SFS information.

```java
cn.ctyun.ctapi.ctecs.ecssfslist.EcsSfsListExample
```

--------------------------------

### BatchStartInstanceJobIDList Methods

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/batchstartinstance/BatchStartInstanceJobIDList.html

Provides methods to set and get job and instance IDs for batch starting instances.

```APIDOC
## BatchStartInstanceJobIDList Methods

### Description
Methods for managing job and instance IDs within the BatchStartInstanceJobIDList.

### Methods

#### withJobID

##### Description
Sets the job ID for the batch start instance operation.

##### Method
public

##### Endpoint
N/A

##### Parameters
- **jobID** (String) - Required - The ID of the job. This can be queried using the 'Query Multiple Asynchronous Task Results' API.

##### Request Example
```json
{
  "example": "batchStartInstanceJobIDList.withJobID(\"your_job_id\")"
}
```

##### Response
- **this** (BatchStartInstanceJobIDList) - Returns the current instance for chaining.

#### withInstanceID

##### Description
Sets the instance ID for the batch start instance operation.

##### Method
public

##### Endpoint
N/A

##### Parameters
- **instanceID** (String) - Required - The cloud host ID corresponding to the task.

##### Request Example
```json
{
  "example": "batchStartInstanceJobIDList.withInstanceID(\"your_instance_id\")"
}
```

##### Response
- **this** (BatchStartInstanceJobIDList) - Returns the current instance for chaining.

#### getJobID

##### Description
Retrieves the job ID.

##### Method
public

##### Endpoint
N/A

##### Parameters
None

##### Response
- **jobID** (String) - The current job ID.

#### setJobID

##### Description
Sets the job ID.

##### Method
public

##### Endpoint
N/A

##### Parameters
- **jobID** (String) - Required - The job ID to set.

##### Response
None

#### getInstanceID

##### Description
Retrieves the instance ID.

##### Method
public

##### Endpoint
N/A

##### Parameters
None

##### Response
- **instanceID** (String) - The current instance ID.

#### setInstanceID

##### Description
Sets the instance ID.

##### Method
public

##### Endpoint
N/A

##### Parameters
- **instanceID** (String) - Required - The instance ID to set.

##### Response
None
```

--------------------------------

### ECS Rebuild Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class demonstrating the ECS rebuild functionality. Use this as a guide for rebuilding ECS instances.

```java
cn.ctyun.ctapi.ctecs.ecsrebuild.EcsRebuildExample
```

--------------------------------

### ECS Resize Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class demonstrating how to resize an ECS instance. Follow this pattern for implementing instance resizing.

```java
cn.ctyun.ctapi.ctecs.ecsresize.EcsResizeExample
```

--------------------------------

### EcsBackupDetails Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class for retrieving details of ECS backups. It allows fetching backup information using the backup ID.

```java
package cn.ctyun.ctapi.ctecs.ecsbackupdetails;

import cn.ctyun.ctapi.ctecs.ecsbackupdetails.EcsBackupDetailsBlockDeviceMappingS;
import cn.ctyun.ctapi.ctecs.ecsbackupdetails.EcsBackupDetailsRequestBody;
import cn.ctyun.ctapi.ctecs.ecsbackupdetails.EcsBackupDetailsResponseData;
import cn.ctyun.ctapi.ctecs.ecsbackupdetails.EcsBackupDetailsRequest;
import cn.ctyun.ctapi.ctecs.ecsbackupdetails.EcsBackupDetailsResults;
import cn.ctyun.ctapi.ctecs.ecsbackupdetails.EcsBackupDetailsReturnObj;

public class EcsBackupDetailsExample {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /**
     * EcsBackupDetails Example
     * @param backupId
     * @return
     */
    public EcsBackupDetailsResponseData ecsBackupDetails(String backupId) {
        EcsBackupDetailsRequest request = new EcsBackupDetailsRequest();
        request.setBackupId(backupId);
        EcsBackupDetailsResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupDetails Example
     * @param requestBody
     * @return
     */
    public EcsBackupDetailsResponseData ecsBackupDetails(EcsBackupDetailsRequestBody requestBody) {
        EcsBackupDetailsRequest request = new EcsBackupDetailsRequest();
        request.setRequestBody(requestBody);
        EcsBackupDetailsResponseData response = request.customize();
        return response;
    }
}
```

--------------------------------

### EcsVpcCreateSecurityGroupIngressExample Constructor

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsvpccreatesecuritygroupingress/EcsVpcCreateSecurityGroupIngressExample.html

Example constructor for the EcsVpcCreateSecurityGroupIngressExample class.

```APIDOC
## EcsVpcCreateSecurityGroupIngressExample()

### Description

This is the default constructor for the EcsVpcCreateSecurityGroupIngressExample class.

### Method

Constructor

### Endpoint

N/A

### Parameters

None

### Request Example

```json
{
  "example": "No request body for constructor"
}
```

### Response

#### Success Response (200)

- **None** - N/A

#### Response Example

```json
{
  "example": "No response body for constructor"
}
```
```

--------------------------------

### EcsAgentBatchDetails Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/overview-tree.html

Provides an example for retrieving batch details of ECS agents. Covers request, response, and result objects.

```java
cn.ctyun.ctapi.ctecs.ecsagentbatchdetails.EcsAgentBatchDetailsExample
```

```java
cn.ctyun.ctapi.ctecs.ecsagentbatchdetails.EcsAgentBatchDetailsRequestBody
```

```java
cn.ctyun.ctapi.ctecs.ecsagentbatchdetails.EcsAgentBatchDetailsResponseData
```

```java
cn.ctyun.ctapi.ctecs.ecsagentbatchdetails.EcsAgentBatchDetailsResults
```

```java
cn.ctyun.ctapi.ctecs.ecsagentbatchdetails.EcsAgentBatchDetailsReturnObj
```

--------------------------------

### EcsBackupBatchUpdate Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class for performing batch updates on ECS backups. Requires appropriate request and response data structures.

```java
package cn.ctyun.ctapi.ctecs.ecsbackupbatchupdate;

import cn.ctyun.ctapi.ctecs.ecsbackupbatchupdate.EcsBackupBatchUpdateRequestBody;
import cn.ctyun.ctapi.ctecs.ecsbackupbatchupdate.EcsBackupBatchUpdateResponseData;
import cn.ctyun.ctapi.ctecs.ecsbackupbatchupdate.EcsBackupBatchUpdateUpdateInfo;
import cn.ctyun.ctapi.ctecs.ecsbackupbatchupdate.EcsBackupBatchUpdateRequest;
import cn.ctyun.ctapi.ctecs.ecsbackupbatchupdate.EcsBackupBatchUpdateRequestBody;

public class EcsBackupBatchUpdateExample {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /**
     * EcsBackupBatchUpdate Example
     * @param backupId
     * @param updateInfo
     * @return
     */
    public EcsBackupBatchUpdateResponseData ecsBackupBatchUpdate(String backupId, EcsBackupBatchUpdateUpdateInfo updateInfo) {
        EcsBackupBatchUpdateRequest request = new EcsBackupBatchUpdateRequest();
        request.setBackupId(backupId);
        request.setUpdateInfo(updateInfo);
        EcsBackupBatchUpdateResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupBatchUpdate Example
     * @param backupId
     * @param updateInfo
     * @return
     */
    public EcsBackupBatchUpdateResponseData ecsBackupBatchUpdate(String backupId, EcsBackupBatchUpdateUpdateInfo[] updateInfo) {
        EcsBackupBatchUpdateRequest request = new EcsBackupBatchUpdateRequest();
        request.setBackupId(backupId);
        request.setUpdateInfo(updateInfo);
        EcsBackupBatchUpdateResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupBatchUpdate Example
     * @param requestBody
     * @return
     */
    public EcsBackupBatchUpdateResponseData ecsBackupBatchUpdate(EcsBackupBatchUpdateRequestBody requestBody) {
        EcsBackupBatchUpdateRequest request = new EcsBackupBatchUpdateRequest();
        request.setRequestBody(requestBody);
        EcsBackupBatchUpdateResponseData response = request.customize();
        return response;
    }
}
```

--------------------------------

### POST /ecs/batch-start

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsbatchstart/package-frame.html

API endpoint for batch starting ECS instances.

```APIDOC
## POST /ecs/batch-start

### Description
Initiates a batch start operation for specified ECS instances.

### Method
POST

### Endpoint
/ecs/batch-start

### Request Body
- **EcsBatchStartRequestBody** (object) - Required - Contains the parameters required to initiate the batch start process.

### Response
#### Success Response (200)
- **EcsBatchStartResponseData** (object) - Contains the result data of the batch start operation.
```

--------------------------------

### EcsBackupDelete Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class for deleting ECS backups. It shows how to specify the backup ID for deletion.

```java
package cn.ctyun.ctapi.ctecs.ecsbackupdelete;

import cn.ctyun.ctapi.ctecs.ecsbackupdelete.EcsBackupDeleteRequestBody;
import cn.ctyun.ctapi.ctecs.ecsbackupdelete.EcsBackupDeleteResponseData;
import cn.ctyun.ctapi.ctecs.ecsbackupdelete.EcsBackupDeleteRequest;
import cn.ctyun.ctapi.ctecs.ecsbackupdelete.EcsBackupDeleteReturnObj;

public class EcsBackupDeleteExample {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /**
     * EcsBackupDelete Example
     * @param backupId
     * @return
     */
    public EcsBackupDeleteResponseData ecsBackupDelete(String backupId) {
        EcsBackupDeleteRequest request = new EcsBackupDeleteRequest();
        request.setBackupId(backupId);
        EcsBackupDeleteResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupDelete Example
     * @param requestBody
     * @return
     */
    public EcsBackupDeleteResponseData ecsBackupDelete(EcsBackupDeleteRequestBody requestBody) {
        EcsBackupDeleteRequest request = new EcsBackupDeleteRequest();
        request.setRequestBody(requestBody);
        EcsBackupDeleteResponseData response = request.customize();
        return response;
    }
}
```

--------------------------------

### EcsBackupRestore Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class for restoring ECS backups. This operation allows users to restore a backup to an ECS instance.

```java
package cn.ctyun.ctapi.ctecs.ecsbackuprestore;

import cn.ctyun.ctapi.ctecs.ecsbackuprestore.EcsBackupRestoreRequestBody;
import cn.ctyun.ctapi.ctecs.ecsbackuprestore.EcsBackupRestoreResponseData;
import cn.ctyun.ctapi.ctecs.ecsbackuprestore.EcsBackupRestoreRequest;
import cn.ctyun.ctapi.ctecs.ecsbackuprestore.EcsBackupRestoreReturnObj;

public class EcsBackupRestoreExample {

    public static void main(String[] args) {
        // TODO Auto-generated method stub

    }

    /**
     * EcsBackupRestore Example
     * @param backupId
     * @param ecsId
     * @return
     */
    public EcsBackupRestoreResponseData ecsBackupRestore(String backupId, String ecsId) {
        EcsBackupRestoreRequest request = new EcsBackupRestoreRequest();
        request.setBackupId(backupId);
        request.setEcsId(ecsId);
        EcsBackupRestoreResponseData response = request.customize();
        return response;
    }

    /**
     * EcsBackupRestore Example
     * @param requestBody
     * @return
     */
    public EcsBackupRestoreResponseData ecsBackupRestore(EcsBackupRestoreRequestBody requestBody) {
        EcsBackupRestoreRequest request = new EcsBackupRestoreRequest();
        request.setRequestBody(requestBody);
        EcsBackupRestoreResponseData response = request.customize();
        return response;
    }
}
```

--------------------------------

### Main Method for EcsVpcCreateSecurityGroupIngressExample

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsvpccreatesecuritygroupingress/EcsVpcCreateSecurityGroupIngressExample.html

The entry point for the EcsVpcCreateSecurityGroupIngressExample class. It accepts an array of strings as arguments.

```java
public static void main(String[] args)

```

--------------------------------

### EcsBatchRebootExample

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-noframe.html

Example class demonstrating batch reboot operations for ECS instances.

```java
cn.ctyun.ctapi.ctecs.ecsbatchreboot.EcsBatchRebootExample
```

--------------------------------

### Instance Management API

Source: https://context7.com/yangpp6/sdk-java-ctecs/llms.txt

APIs for managing ECS instances including getting details, starting, stopping, and rebooting.

```APIDOC
## GET /api/instances/{instanceId}

### Description
Retrieve detailed information about a specific ECS instance by its ID.

### Method
GET

### Endpoint
/api/instances/{instanceId}

### Parameters
#### Path Parameters
- **instanceId** (string) - Required - The ID of the ECS instance.

#### Query Parameters
- **regionID** (string) - Required - The ID of the region.

### Response
#### Success Response (200)
- **InstanceDetailsResponseData** (object) - Contains the detailed information of the instance.

### Response Example
```json
{
  "data": {
    "instanceId": "adc614e0-e838-d73f-0618-a6d51d09070a",
    "regionID": "bb9fdb42056f11eda1610242ac110002",
    "instanceName": "example-instance"
  }
}
```
```

```APIDOC
## POST /api/instances/start

### Description
Start a stopped ECS instance.

### Method
POST

### Endpoint
/api/instances/start

### Parameters
#### Request Body
- **regionID** (string) - Required - The ID of the region.
- **instanceID** (string) - Required - The ID of the ECS instance to start.

### Request Example
```json
{
  "regionID": "bb9fdb42056f11eda1610242ac110002",
  "instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a"
}
```

### Response
#### Success Response (200)
- **StartInstanceResponseData** (object) - Contains the result of the start instance operation.

### Response Example
```json
{
  "data": {
    "status": "starting"
  }
}
```
```

```APIDOC
## POST /api/instances/stop

### Description
Stop a running ECS instance.

### Method
POST

### Endpoint
/api/instances/stop

### Parameters
#### Request Body
- **regionID** (string) - Required - The ID of the region.
- **instanceID** (string) - Required - The ID of the ECS instance to stop.

### Request Example
```json
{
  "regionID": "bb9fdb42056f11eda1610242ac110002",
  "instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a"
}
```

### Response
#### Success Response (200)
- **StopInstanceResponseData** (object) - Contains the result of the stop instance operation.

### Response Example
```json
{
  "data": {
    "status": "stopping"
  }
}
```
```

```APIDOC
## POST /api/instances/reboot

### Description
Reboot a running ECS instance.

### Method
POST

### Endpoint
/api/instances/reboot

### Parameters
#### Request Body
- **regionID** (string) - Required - The ID of the region.
- **instanceID** (string) - Required - The ID of the ECS instance to reboot.

### Request Example
```json
{
  "regionID": "bb9fdb42056f11eda1610242ac110002",
  "instanceID": "adc614e0-e838-d73f-0618-a6d51d09070a"
}
```

### Response
#### Success Response (200)
- **RebootInstanceResponseData** (object) - Contains the result of the reboot instance operation.

### Response Example
```json
{
  "data": {
    "status": "rebooting"
  }
}
```
```

--------------------------------

### LiveResizeFlavorListExample.main Method

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/liveresizeflavorlist/LiveResizeFlavorListExample.html

The main method for executing the LiveResizeFlavorListExample.

```APIDOC
## main(String[] args)

### Description

The main method for executing the LiveResizeFlavorListExample. It serves as the entry point for the program.

### Method

public static void main

### Endpoint

N/A

### Parameters

- **args** (String[]) - Required - Command line arguments passed to the program.

### Request Example

N/A

### Response

N/A
```

--------------------------------

### LiveResizeFlavorListExample.run Method

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/liveresizeflavorlist/LiveResizeFlavorListExample.html

Executes the live resize flavor list operation with provided credentials and endpoint.

```APIDOC
## run(String ak, String sk, String endingPoint)

### Description

This method executes the live resize flavor list operation. It requires authentication credentials (access key and secret key) and the endpoint URL.

### Method

public static String run

### Endpoint

N/A

### Parameters

- **ak** (String) - Required - The access key for authentication.
- **sk** (String) - Required - The secret key for authentication.
- **endingPoint** (String) - Required - The endpoint URL for the API.

### Request Example

N/A

### Response

- **String** - A string representing the result of the operation. (Specific format not detailed in source)

### Response Example

N/A
```

--------------------------------

### EcsBatchStartRequestBody

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-noframe.html

Request body for batch start operations, specifying ECS instances to start.

```java
cn.ctyun.ctapi.ctecs.ecsbatchstart.EcsBatchStartRequestBody
```

--------------------------------

### EcsVpcCreateSecurityGroupIngressExample.main

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsvpccreatesecuritygroupingress/EcsVpcCreateSecurityGroupIngressExample.html

The main method for executing the EcsVpcCreateSecurityGroupIngressExample.

```APIDOC
## main(String[] args)

### Description

This is the main method used to execute the example class. It accepts command-line arguments.

### Method

`public static void main(String[] args)`

### Endpoint

N/A

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

None

### Request Example

```json
{
  "example": "No request body for main method"
}
```

### Response

#### Success Response (200)

- **None** - N/A

#### Response Example

```json
{
  "example": "No response body for main method"
}
```
```

--------------------------------

### Method: run

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/snapshotcreateinstance/SnapshotCreateInstanceExample.html

Executes the snapshot creation instance using provided credentials and endpoint.

```APIDOC
## static String run(String ak, String sk, String endingPoint)

### Description
Executes the snapshot creation instance process using the provided Access Key, Secret Key, and API endpoint.

### Parameters
#### Request Body
- **ak** (String) - Required - The Access Key for authentication.
- **sk** (String) - Required - The Secret Key for authentication.
- **endingPoint** (String) - Required - The API endpoint URL.

### Response
#### Success Response (200)
- **result** (String) - Returns the result of the snapshot creation process as a String.
```

--------------------------------

### EcsAttachShareInterface Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/overview-tree.html

Demonstrates how to attach a shared interface to an ECS instance. Includes example request and response objects.

```java
cn.ctyun.ctapi.ctecs.ecsattachshareinterface.EcsAttachShareInterfaceExample
```

```java
cn.ctyun.ctapi.ctecs.ecsattachshareinterface.EcsAttachShareInterfaceRequestBody
```

```java
cn.ctyun.ctapi.ctecs.ecsattachshareinterface.EcsAttachShareInterfaceResponseData
```

```java
cn.ctyun.ctapi.ctecs.ecsattachshareinterface.EcsAttachShareInterfaceReturnObj
```

--------------------------------

### EcsVpcCreateSecurityGroupIngressExample.run

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsvpccreatesecuritygroupingress/EcsVpcCreateSecurityGroupIngressExample.html

Executes the security group ingress creation example with provided credentials and endpoint.

```APIDOC
## run(String ak, String sk, String endingPoint)

### Description

This static method runs the example for creating a security group ingress. It requires Alibaba Cloud Access Key ID, Access Key Secret, and the endpoint URL.

### Method

`public static String run(String ak, String sk, String endingPoint)`

### Endpoint

N/A

### Parameters

#### Path Parameters

None

#### Query Parameters

None

#### Request Body

None

### Request Example

```json
{
  "example": "No request body for run method"
}
```

### Response

#### Success Response (200)

- **String** - A string representing the result of the operation. This could be a success message or an identifier.

#### Response Example

```json
{
  "example": "Success message or identifier string"
}
```
```

--------------------------------

### InstanceDetailsReturnObj Configuration Methods

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/instancedetails/InstanceDetailsReturnObj.html

Methods for configuring instance details such as security groups, subnets, VPC information, and resource associations.

```APIDOC
## InstanceDetailsReturnObj Configuration

### Description
Methods to set various attributes for an instance detail object, including network configurations, timestamps, and resource associations.

### Methods
- **setSecGroupList(InstanceDetailsSecGroupList[] secGroupList)**: Sets the list of security groups.
- **setSubnetIDList(String[] subnetIDList)**: Sets the list of subnet IDs.
- **setUpdatedTime(String updatedTime)**: Sets the last updated timestamp.
- **setVipCount(Integer vipCount)**: Sets the count of virtual IPs.
- **setVipInfoList(InstanceDetailsVipInfoList[] vipInfoList)**: Sets the list of virtual IP information.
- **setVpcID(String vpcID)**: Sets the VPC ID.
- **setVpcName(String vpcName)**: Sets the VPC name.
- **setZabbixName(String zabbixName)**: Sets the Zabbix name.

### Builder Methods
- **withAddresses(InstanceDetailsAddresses[] addresses)**: Sets addresses and returns the object.
- **withAffinityGroup(InstanceDetailsAffinityGroup affinityGroup)**: Sets affinity group and returns the object.
- **withAttachedVolume(String[] attachedVolume)**: Sets attached volumes and returns the object.
- **withAvailableDay(Integer availableDay)**: Sets available days and returns the object.
```

--------------------------------

### EcsStart API Overview

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsstart/package-frame.html

This section provides an overview of the EcsStart API and its associated classes.

```APIDOC
## EcsStart API

### Description
This API is part of the sdk-java-ctecs project and is related to starting ECS instances. It includes several key classes that define the request, response, and examples for this operation.

### Classes

*   **EcsStartExample**: Provides examples for using the EcsStart API.
*   **EcsStartRequest**: Defines the structure of the request to start an ECS instance.
*   **EcsStartRequestBody**: Represents the body of the request for starting an ECS instance.
*   **EcsStartResponseData**: Defines the structure of the data returned in a successful response.
*   **EcsStartReturnObj**: Represents the overall return object for the EcsStart operation.
```

--------------------------------

### ECS Resubscribe Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class demonstrating the ECS resubscribe functionality. Use this as a template for resubscribing to ECS services.

```java
cn.ctyun.ctapi.ctecs.ecsresubscribe.EcsResubscribeExample
```

--------------------------------

### EcsLiteStart API

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/overview-tree.html

Provides details on how to start an Elastic Compute Service (ECS) instance. Includes request and response structures.

```APIDOC
## POST /api/v1/ecs/start

### Description
Starts a specified Elastic Compute Service (ECS) instance.

### Method
POST

### Endpoint
/api/v1/ecs/start

### Parameters
#### Request Body
- **instanceId** (string) - Required - The ID of the ECS instance to start.

### Request Example
```json
{
  "instanceId": "ecs-abcdef123456"
}
```

### Response
#### Success Response (200)
- **data** (object) - Contains information about the start operation.
  - **taskId** (string) - The ID of the task initiated for the start operation.

#### Response Example
```json
{
  "requestId": "mno-345",
  "returnCode": 0,
  "message": "Success",
  "data": {
    "taskId": "task-uvw678"
  }
}
```
```

--------------------------------

### ECS Shelve Instance Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/overview-tree.html

Example class for shelving ECS instances. Manages the process of putting instances into a shelved state.

```java
cn.ctyun.ctapi.ctecs.ecsshelveinstance.EcsShelveInstanceExample
```

--------------------------------

### ECS SFS Detach Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

Example class demonstrating how to detach an SFS from an ECS instance. Use this as a reference for SFS detachment.

```java
cn.ctyun.ctapi.ctecs.ecssfsdetach.EcsSfsDetachExample
```

--------------------------------

### backupCreateInstance

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/CtecsClient.html

Create a new cloud host using an existing backup.

```APIDOC
## backupCreateInstance

### Description
Create a new cloud host using an existing backup. The new host will have the same specifications, image, and disk data as the backup.

### Request Body
- **request** (BackupCreateInstanceRequest) - Required - The request object containing backup and configuration details.
```

--------------------------------

### ECS Reboot Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/allclasses-frame.html

An example class demonstrating how to use the ECS reboot functionality. This serves as a reference for implementing reboot operations.

```java
cn.ctyun.ctapi.ctecs.ecsreboot.EcsRebootExample
```

--------------------------------

### Run Method for EcsVpcCreateSecurityGroupIngressExample

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsvpccreatesecuritygroupingress/EcsVpcCreateSecurityGroupIngressExample.html

Executes the main logic of the EcsVpcCreateSecurityGroupIngressExample. Requires AK, SK, and endpoint as string arguments. Returns a String.

```java
public static String run(String ak,
                             String sk,
                             String endingPoint)

```

--------------------------------

### main Method

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/shareinterfaceattach/ShareInterfaceAttachExample.html

The entry point for the ShareInterfaceAttachExample application.

```APIDOC
## main(String[] args)

### Description

This is the main method that serves as the entry point for the program. It can be used to execute the ShareInterfaceAttachExample functionality.

### Method

`public static void main(String[] args)`

### Endpoint

N/A (Method)
```

--------------------------------

### QueryResizeFlavorExample

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/queryresizeflavor/QueryResizeFlavorExample.html

This class contains the main method and the run method for the Query Resize Flavor example.

```APIDOC
## QueryResizeFlavorExample

### Description
This class contains the main method and the run method for the Query Resize Flavor example.

### Methods

#### main

```java
public static void main(String[] args)
```

#### run

```java
public static String run(String ak, String sk, String endingPoint)
```
```

--------------------------------

### Start ECS Instance

Source: https://context7.com/yangpp6/sdk-java-ctecs/llms.txt

Start a stopped ECS instance. Requires region and instance IDs. The request body contains these details.

```java
import cn.ctyun.ctapi.ctecs.startinstance.*

StartInstanceRequestBody body = new StartInstanceRequestBody()
    .withRegionID("bb9fdb42056f11eda1610242ac110002")
    .withInstanceID("adc614e0-e838-d73f-0618-a6d51d09070a");

StartInstanceRequest request = new StartInstanceRequest().withBody(body);
CTResponse<StartInstanceResponseData> response = client.startInstance(request);

System.out.println("Start Result: " + response.getData());
```

--------------------------------

### ECS Snapshot Batch Update Example

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/overview-tree.html

Example class for batch updating ECS snapshots. Manages operations for multiple snapshot updates.

```java
cn.ctyun.ctapi.ctecs.ecssnapshotbatchupdate.EcsSnapshotBatchUpdateExample
```

--------------------------------

### InstanceDetailsReturnObj Configuration Methods

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/instancedetails/InstanceDetailsReturnObj.html

Methods for setting various attributes of an instance detail object, such as project ID, availability zone, and resource identifiers.

```APIDOC
## InstanceDetailsReturnObj Methods

### Description
These methods are used to set properties on the InstanceDetailsReturnObj object.

### Parameters
#### Request Body
- **projectID** (String) - Optional - 企业项目ID
- **azName** (String) - Optional - 可用区名称
- **attachedVolume** (String[]) - Optional - 云硬盘ID列表
- **addresses** (InstanceDetailsAddresses[]) - Optional - 网络地址信息
- **resourceID** (String) - Optional - 云主机资源ID
- **instanceID** (String) - Optional - 云主机ID

### Response
- **this** (InstanceDetailsReturnObj) - Returns the current instance for method chaining.
```

--------------------------------

### Get Password

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsbatchpasswordupdate/EcsBatchPasswordUpdateUpdatePwdInfo.html

Retrieves the user password.

```java
public String getPassword()
```

--------------------------------

### Instance Configuration

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/batchcreateinstances/BatchCreateInstancesRequestBody.html

Methods for configuring instance properties.

```APIDOC
## Instance Configuration

### Description
Provides methods to set and retrieve instance-specific configurations.

### Methods

#### `setInstanceName(String instanceName)`
Sets the instance name.

#### `getInstanceName()`
Gets the instance name.

#### `setDisplayName(String displayName)`
Sets the display name for the instance.

#### `getDisplayName()`
Gets the display name of the instance.

#### `setFlavorID(String flavorID)`
Sets the flavor ID for the instance.

#### `getFlavorID()`
Gets the flavor ID of the instance.

#### `setImageType(Integer imageType)`
Sets the image type for the instance.

#### `getImageType()`
Gets the image type of the instance.

#### `setImageID(String imageID)`
Sets the image ID for the instance.

#### `getImageID()`
Gets the image ID of the instance.

#### `setBootDiskType(String bootDiskType)`
Sets the boot disk type for the instance.

#### `getBootDiskType()`
Gets the boot disk type of the instance.

#### `setBootDiskSize(Integer bootDiskSize)`
Sets the boot disk size for the instance.

#### `getBootDiskSize()`
Gets the boot disk size of the instance.

#### `setVpcID(String vpcID)`
Sets the VPC ID for the instance.

#### `getVpcID()`
Gets the VPC ID of the instance.

#### `setOnDemand(Boolean onDemand)`
Sets the on-demand status for the instance.

#### `getOnDemand()`
Gets the on-demand status of the instance.

#### `setNetworkCardList(BatchCreateInstancesNetworkCardList[] networkCardList)`
Sets the network card list for the instance.

#### `getNetworkCardList()`
Gets the network card list of the instance.

#### `setExtIP(String extIP)`
Sets the external IP address for the instance.

#### `getExtIP()`
Gets the external IP address of the instance.

#### `setProjectID(String projectID)`
Sets the project ID for the instance.

#### `getProjectID()`
Gets the project ID of the instance.
```

--------------------------------

### Bandwidth Management

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/listflavor/ListFlavorFlavorList.html

Methods for getting and setting the bandwidth.

```APIDOC
## GET /bandwidth

### Description
Retrieves the bandwidth value.

### Method
GET

### Endpoint
/bandwidth

### Response
#### Success Response (200)
- **bandwidth** (Float) - The bandwidth value (e.g., in Mbps).

#### Response Example
```json
{
  "bandwidth": 100.5
}
```

## POST /bandwidth

### Description
Sets the bandwidth value.

### Method
POST

### Endpoint
/bandwidth

### Request Body
- **bandwidth** (Float) - The bandwidth value to set (e.g., in Mbps).

### Request Example
```json
{
  "bandwidth": 200.0
}
```
```

--------------------------------

### InstanceDetailsVipInfoList Configuration Methods

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/instancedetails/InstanceDetailsVipInfoList.html

Methods for setting and configuring VIP information fields such as VIP ID, NIC ID, and associated IP addresses.

```APIDOC
## InstanceDetailsVipInfoList Configuration

### Description
Methods to configure the VIP information list for instance details, including setting identifiers and network interface bindings.

### Methods
- **withNicID(String nicID)**: Sets the NIC ID.
- **withVipAddress(String vipAddress)**: Sets the VIP address.
- **withVipBindNicIP(String vipBindNicIP)**: Sets the VIP bound NIC IP.
- **withVipBindNicIPv6(String vipBindNicIPv6)**: Sets the VIP bound NIC IPv6 address.
- **withVipID(String vipID)**: Sets the VIP ID.
- **setVipBindNicIPv6(String vipBindNicIPv6)**: Sets the VIP bound NIC IPv6 address.
- **setVipID(String vipID)**: Sets the VIP ID.
```

--------------------------------

### Name Management

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecssnapshotlist/EcsSnapshotListRequestBody.html

APIs for setting and getting the name.

```APIDOC
## setName

### Description
Sets the name.

### Method
POST

### Endpoint
/api/name

### Parameters
#### Request Body
- **name** (String) - Required - The name to set.

### Request Example
{
  "name": "example-name"
}

## getName

### Description
Gets the name.

### Method
GET

### Endpoint
/api/name
```

--------------------------------

### Status Management

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecssnapshotlist/EcsSnapshotListRequestBody.html

APIs for setting and getting the status.

```APIDOC
## setStatus

### Description
Sets the status.

### Method
POST

### Endpoint
/api/status

### Parameters
#### Request Body
- **status** (String) - Required - The status to set.

### Request Example
{
  "status": "active"
}

## getStatus

### Description
Gets the status.

### Method
GET

### Endpoint
/api/status
```

--------------------------------

### SnapshotPolicyCreateExample.run

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/snapshotpolicycreate/SnapshotPolicyCreateExample.html

Executes the snapshot policy creation process using provided authentication credentials and endpoint.

```APIDOC
## SnapshotPolicyCreateExample.run

### Description
Executes the snapshot policy creation request using the provided access key, secret key, and endpoint.

### Parameters
- **ak** (String) - Required - Access Key for authentication.
- **sk** (String) - Required - Secret Key for authentication.
- **endingPoint** (String) - Required - The API endpoint URL.

### Response
- **Returns** (String) - The result of the snapshot policy creation operation.
```

--------------------------------

### ID Management

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecssnapshotlist/EcsSnapshotListRequestBody.html

APIs for setting and getting the ID.

```APIDOC
## setID

### Description
Sets the ID.

### Method
POST

### Endpoint
/api/id

### Parameters
#### Request Body
- **ID** (String) - Required - The ID to set.

### Request Example
{
  "ID": "some-id"
}

## getID

### Description
Gets the ID.

### Method
GET

### Endpoint
/api/id
```

--------------------------------

### Main Method

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/ecsbatchdelete/EcsBatchDeleteExample.html

The main method serves as the entry point for the application.

```APIDOC
## main

### Description

The `main` method is the entry point for the Java application.

### Method

`public static void main(String[] args)`

### Parameters

*   **args** (String[]) - Command line arguments passed to the application.
```

--------------------------------

### Size Management

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/createrepo/CreateRepoRequestBody.html

Methods for getting and setting the size.

```APIDOC
## GET /api/size

### Description
Retrieves the size.

### Method
GET

### Endpoint
/api/size

### Response
#### Success Response (200)
- **size** (Integer) - The size.

#### Response Example
```json
{
  "size": 1024
}
```

## POST /api/size

### Description
Sets the size.

### Method
POST

### Endpoint
/api/size

### Parameters
#### Request Body
- **size** (Integer) - Required - The size to set.

### Request Example
```json
{
  "size": 2048
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message.

#### Response Example
```json
{
  "message": "Size updated successfully."
}
```
```

--------------------------------

### UpdateNetworkSpecExample Class

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/updatenetworkspec/UpdateNetworkSpecExample.html

Provides an example of how to update a network specification.

```APIDOC
## UpdateNetworkSpecExample

### Description
This class serves as an example for updating network specifications.

### Methods

#### main

```java
public static void main(String[] args)
```

##### Description
Entry point for the example application.

#### run

```java
public static String run(String ak, String sk, String endingPoint)
```

##### Description
Executes the network specification update process.

##### Parameters

###### Path Parameters
* None

###### Query Parameters
* None

###### Request Body
* None

### Request Example
```json
{
  "example": "No request body defined for this method."
}
```

### Response
#### Success Response (200)
* **String** - Description of the returned string is not provided.

#### Response Example
```json
{
  "example": "Response details not specified."
}
```
```

--------------------------------

### On-Demand Management

Source: https://github.com/yangpp6/sdk-java-ctecs/blob/master/target/apidocs/cn/ctyun/ctapi/ctecs/volumecreate/VolumeCreateRequestBody.html

Methods for getting and setting the on-demand status.

```APIDOC
## GET /onDemand

### Description
Retrieves the on-demand status.

### Method
GET

### Endpoint
/onDemand

### Response
#### Success Response (200)
- **onDemand** (Boolean) - The current on-demand status (true/false).

#### Response Example
```json
{
  "onDemand": true
}
```

## POST /onDemand

### Description
Sets the on-demand status.

### Method
POST

### Endpoint
/onDemand

### Parameters
#### Request Body
- **onDemand** (Boolean) - The on-demand status to set (true/false).

### Request Example
```json
{
  "onDemand": false
}
```

### Response
#### Success Response (200)
- **message** (String) - Confirmation message.

#### Response Example
```json
{
  "message": "On-demand status updated successfully."
}
```
```
Tokens:
Raw