版本说明

本示例基于华为云SDK开发。

功能介绍

华为云提供了CloudIDE服务端SDK，您可以直接集成服务端SDK来调用CloudIDE的相关API，从而实现对CloudIDE的快速操作。 该示例展示了如何通过Python版SDK查询实例列表、启动和停止实例，并返回操作结果。

前置条件

• 1、获取华为云开发工具包（SDK），您也可以查看安装Python SDK。
• 2、要使用华为云 Python SDK，您需要拥有华为云账号以及该账号对应的 Access Key（AK）和 Secret Access Key（SK）。
• 3、华为云 Python SDK 支持 Python 3 及其以上版本。

初始化

                    
                    Copied!
                
# 创建CloudIDEClient实例，AK/SK/ProjectId填写服务华为云账号控制台中"我的凭证"及"访问密钥"相关数据
# 认证用的ak和sk直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全；
# 本示例以ak和sk保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
ak = os.environ["HUAWEICLOUD_SDK_AK"]
sk = os.environ["HUAWEICLOUD_SDK_SK"]
credentials = BasicCredentials(
	ak=ak,
	sk=sk
)
client = CloudIDEClient.new_builder() \
	.with_credentials(credentials=credentials) \
	.with_region(region=CloudIDERegion.CN_NORTH_4) \
	.build()

查询IDE实例列表

                    
                    Copied!
                
try:
	request = ListInstancesRequest()
	response = client.list_instances(request)
	print(response)
	return response.instances.items
except ServerResponseException as e:
	print(str(e.status_code))
	print(e.error_msg)
	return None

说明：

• 参数信息请参考API Explorer。

启动IDE实例

                    
                    Copied!
                
try:
	request = StartInstanceRequest()
	request.instance_id = instance_id
	response = client.start_instance(request)
	print(response)
except ServerResponseException as e:
	print(str(e.status_code))
	print(e.error_msg)

说明：

• 通过查询实例列表接口获取到待启动实例的ID
• 停止中/删除中的实例不允许启动
• 参数信息请参考API Explorer。

停止IDE实例

                    
                    Copied!
                
try:
	request = StopInstanceRequest()
	request.instance_id = instance_id
	response = client.stop_instance(request)
	print(response)
except ServerResponseException as e:
	print(str(e.status_code))
	print(e.error_msg)

说明：

• 通过查询实例列表接口获取到待启动实例的ID
• 启动中、运行中、就绪状态的实例才允许停止，停止IDE实例不删除磁盘数据
• 参数信息请参考API Explorer。

参考

更多信息请参考CloudIDE

修订记录