Asynchronously Exporting Instances
Function
This API is used to export the required instance list.
Calling Method
For details, see Calling APIs.
URI
POST /v2/{project_id}/instances/export
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details, see Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
included_instances |
No |
Array of strings |
Export the instance list. If this parameter is left blank, all instances that satisfy other parameters are exported. |
region |
Yes |
String |
Site name, which is used to name the exported file. |
name |
No |
String |
Filter instances by instance name. |
capacity |
No |
String |
Filter instances by instance capacity. |
instance_id |
No |
String |
Filter instances by instance ID. |
ip |
No |
String |
Filter instances by IP address. |
available_zone |
No |
String |
Filter instances by AZ. |
status |
No |
String |
Filters instances by instance status. Options:
|
product_type |
No |
String |
Filter instances by edition. The value can be generic (normal edition) or enterprise (professional edition). |
cache_mode |
No |
String |
Filters instances by instance type. Options:
|
engine |
No |
String |
Filter instances by cache engine. Currently, Redis is used. |
engine_version |
No |
String |
Filter instances by cache engine version. |
cpu_type |
No |
String |
Filter instances by CPU type. The value can be x86_64 or aarch64. |
enterprise_project_id |
No |
String |
Filter instances by enterprise project ID. |
charging_mode |
No |
String |
Filter instances by billing mode. |
tags |
No |
String |
Filter instances by tag. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
job_id |
String |
ID of the instance export task. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_msg |
String |
Error message. |
error_code |
String |
Error code. |
error_ext_msg |
String |
Extended error information. This parameter is not used currently and is set to null. |
Example Requests
POST https://{dcs_endpoint}/v2/{project_id}/instances/export { "included_instances" : [ ], "region" : "Region", "name" : "name", "capacity" : "2", "instance_id" : "52f265a5-13c4-42cc-b0fa-38ef830e6391", "ip" : "192.168.78.24", "available_zone" : "d539378ec1314c85b76fefa3f7071458", "status" : "RUNNING", "product_type" : "generic", "cache_mode" : "proxy", "engine" : "Redis", "engine_version" : "4.0", "cpu_type" : "x86", "enterprise_project_id" : "93085bd3-6a84-4acc-bc70-5ebfa18c77b6", "charging_mode" : "0", "tags" : "aaa=cccc" }
Example Responses
Status code: 200
Success response for asynchronously exporting the instance list.
{ "job_id" : "ff80808188bfde180188c223434d6f7a" }
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.dcs.v2.region.DcsRegion; import com.huaweicloud.sdk.dcs.v2.*; import com.huaweicloud.sdk.dcs.v2.model.*; import java.util.List; import java.util.ArrayList; public class ExportInstancesTaskSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); DcsClient client = DcsClient.newBuilder() .withCredential(auth) .withRegion(DcsRegion.valueOf("<YOUR REGION>")) .build(); ExportInstancesTaskRequest request = new ExportInstancesTaskRequest(); ExportInstancesTaskBody body = new ExportInstancesTaskBody(); body.withTags("aaa=cccc"); body.withChargingMode("0"); body.withEnterpriseProjectId("93085bd3-6a84-4acc-bc70-5ebfa18c77b6"); body.withCpuType("x86"); body.withEngineVersion("4.0"); body.withEngine("Redis"); body.withCacheMode("proxy"); body.withProductType(ExportInstancesTaskBody.ProductTypeEnum.fromValue("generic")); body.withStatus("RUNNING"); body.withAvailableZone("d539378ec1314c85b76fefa3f7071458"); body.withIp("192.168.78.24"); body.withInstanceId("52f265a5-13c4-42cc-b0fa-38ef830e6391"); body.withCapacity("2"); body.withName("name"); body.withRegion("Region"); request.withBody(body); try { ExportInstancesTaskResponse response = client.exportInstancesTask(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkdcs.v2.region.dcs_region import DcsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkdcs.v2 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = DcsClient.new_builder() \ .with_credentials(credentials) \ .with_region(DcsRegion.value_of("<YOUR REGION>")) \ .build() try: request = ExportInstancesTaskRequest() request.body = ExportInstancesTaskBody( tags="aaa=cccc", charging_mode="0", enterprise_project_id="93085bd3-6a84-4acc-bc70-5ebfa18c77b6", cpu_type="x86", engine_version="4.0", engine="Redis", cache_mode="proxy", product_type="generic", status="RUNNING", available_zone="d539378ec1314c85b76fefa3f7071458", ip="192.168.78.24", instance_id="52f265a5-13c4-42cc-b0fa-38ef830e6391", capacity="2", name="name", region="Region" ) response = client.export_instances_task(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" dcs "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dcs/v2/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := dcs.NewDcsClient( dcs.DcsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ExportInstancesTaskRequest{} tagsExportInstancesTaskBody:= "aaa=cccc" chargingModeExportInstancesTaskBody:= "0" enterpriseProjectIdExportInstancesTaskBody:= "93085bd3-6a84-4acc-bc70-5ebfa18c77b6" cpuTypeExportInstancesTaskBody:= "x86" engineVersionExportInstancesTaskBody:= "4.0" engineExportInstancesTaskBody:= "Redis" cacheModeExportInstancesTaskBody:= "proxy" productTypeExportInstancesTaskBody:= model.GetExportInstancesTaskBodyProductTypeEnum().GENERIC statusExportInstancesTaskBody:= "RUNNING" availableZoneExportInstancesTaskBody:= "d539378ec1314c85b76fefa3f7071458" ipExportInstancesTaskBody:= "192.168.78.24" instanceIdExportInstancesTaskBody:= "52f265a5-13c4-42cc-b0fa-38ef830e6391" capacityExportInstancesTaskBody:= "2" nameExportInstancesTaskBody:= "name" request.Body = &model.ExportInstancesTaskBody{ Tags: &tagsExportInstancesTaskBody, ChargingMode: &chargingModeExportInstancesTaskBody, EnterpriseProjectId: &enterpriseProjectIdExportInstancesTaskBody, CpuType: &cpuTypeExportInstancesTaskBody, EngineVersion: &engineVersionExportInstancesTaskBody, Engine: &engineExportInstancesTaskBody, CacheMode: &cacheModeExportInstancesTaskBody, ProductType: &productTypeExportInstancesTaskBody, Status: &statusExportInstancesTaskBody, AvailableZone: &availableZoneExportInstancesTaskBody, Ip: &ipExportInstancesTaskBody, InstanceId: &instanceIdExportInstancesTaskBody, Capacity: &capacityExportInstancesTaskBody, Name: &nameExportInstancesTaskBody, Region: "Region", } response, err := client.ExportInstancesTask(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
200 |
Success response for asynchronously exporting the instance list. |
400 |
Invalid request. |
401 |
Invalid authentication information. |
403 |
Request rejected. |
404 |
The requested resource could not be found. |
500 |
Internal service error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot