华为云用户手册

URI GET /v2/{project_id}/msgsms/apps 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，参考“获取帐号、用户、项目的名称和ID” 表2 Query参数 参数 是否必选 参数类型 描述 app_name 否 String 应用名称 end_time 否 String 结束时间 limit 否 Integer 数量，默认值10 offset 否 Integer 偏移量 region 否 String 地域 cn：国内 intl：国际 sort_dir 否 String 排序方式 desc：降序 asc：升序 sort_key 否 String 排序字段，仅支持create_time start_time 否 String 开始时间 status 否 String 状态

安装SDK 执行如下命令安装华为云Python SDK核心库以及相关服务库。 使用SDK前，您需要安装“huaweicloudsdkcore”和“huaweicloudsdkmsgsms”，具体的SDK版本号请参见SDK开发中心。 使用pip安装 执行如下命令安装华为云Python SDK核心库以及相关服务库： # 安装核心库 pip install huaweicloudsdkcore # 安装MSG SMS 服务库 pip install huaweicloudsdkmsgsms 使用源码安装 执行如下命令安装华为云Python SDK核心库以及相关服务库： # 安装核心库 cd huaweicloudsdkcore-${version} python setup.py install # 安装MSGSMS服务库 cd huaweicloudsdkmsgsms-${version} python setup.py install

代码示例 以调用创建短信应用接口为例，以下代码示例向您展示使用Python SDK的主要步骤： 创建认证。 创建MsgsmsClient实例并初始化。 实例化请求对象。 调用创建短信应用接口。 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmsgsms.v2.region.msgsms_region import MsgsmsRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmsgsms.v2 import * if __name__ == "__main__": # 认证用的ak和sk直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 # 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。 ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] # 创建认证 # 创建BasicCredentials实例并初始化 credentials = BasicCredentials(ak, sk) client = MsgsmsClient.new_builder() \ .with_credentials(credentials) \ .with_region(MsgsmsRegion.value_of("cn-north-4")) \ .build() try: # 实例化请求对象 request = CreateAppRequest() request.body = SmsAppAddReq( ) # 调用创建短信应用接口 response = client.create_app(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) 参数 说明 ak 您的华为云账号访问密钥ID（Access Key ID）。 sk 您的华为云账号秘密访问密钥（Secret Access Key）。 MsgsmsRegion.valueOf("cn-north-4") 请替换为您要访问的MSGSMS平台所在区域，当前MSGSMS支持访问的区域，在SDK代码msgsms_region.py中已经定义。 您可以在MSGSMS控制台页面左上角查看当前服务所在区 域名 称。 项目源码及更多详细的使用指导请参考华为云Python软件开发工具包（Python SDK）。 推荐您使用API在线调试工具 API Explorer ，API Explorer支持快速调试和检索，调试API的同时，可以根据您的参数实时生成各种开发语言的SDK示例代码，方便您直接根据示例代码使用SDK。

代码示例 以调用创建短信应用接口为例，以下代码示例向您展示使用Java SDK的主要步骤： 创建认证。 创建MsgsmsClient实例并初始化。 实例化请求对象。 调用创建短信应用接口。 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.msgsms.v2.region.MsgsmsRegion; import com.huaweicloud.sdk.msgsms.v2.*; import com.huaweicloud.sdk.msgsms.v2.model.*; public class CreateAppSolution { public static void main(String[] args) { // 认证用的ak和sk直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 // 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。 String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); // 创建认证 ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); // 创建MsgsmsClient实例并初始化 MsgsmsClient client = MsgsmsClient.newBuilder() .withCredential(auth) .withRegion(MsgsmsRegion.valueOf("cn-north-4")) .build(); // 实例化请求对象 CreateAppRequest request = new CreateAppRequest(); SmsAppAddReq body = new SmsAppAddReq(); request.withBody(body); try { // 调用创建短信应用接口 CreateAppResponse response = client.createApp(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()); } } } 参数 说明 ak 您的华为云账号访问密钥ID（Access Key ID）。 sk 您的华为云账号秘密访问密钥（Secret Access Key）。 MsgsmsRegion.valueOf("cn-north-4") 请替换为您要访问的MSGSMS平台所在区域，当前MSGSMS支持访问的区域，在SDK代码MsgsmsRegion.java中已经定义。 您可以在MSGSMS控制台页面左上角查看当前服务所在区域名称。 项目源码及更多详细的使用指导请参考华为云Java软件开发工具包（Java SDK）。 推荐您使用API在线调试工具API Explorer ，API Explorer支持快速调试和检索，调试API的同时，可以根据您的参数实时生成各种开发语言的SDK示例代码，方便您直接根据示例代码使用SDK。

代码示例 以调用创建短信应用接口为例，以下代码示例向您展示使用Go SDK的主要步骤： 创建认证。 创建MsgsmsClient实例并初始化。 实例化请求对象。 调用创建短信应用接口。 package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" msgsms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/msgsms/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/msgsms/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/msgsms/v2/region" ) func main() { // 认证用的ak和sk直接写到代码中有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 // 本示例以ak和sk保存在环境变量中为例，运行本示例前请先在本地环境中设置环境变量CLOUD_SDK_AK和CLOUD_SDK_SK。 ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") // 创建认证 auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() // 创建MsgsmsClient实例并初始化 client := msgsms.NewMsgsmsClient( msgsms.MsgsmsClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) // 实例化请求对象 request := &model.CreateAppRequest{} request.Body = &model.SmsAppAddReq{ } // 调用创建短信应用接口 response, err := client.CreateApp(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } 参数 说明 ak 您的华为云账号访问密钥ID（Access Key ID）。 sk 您的华为云账号秘密访问密钥（Secret Access Key）。 region.ValueOf("cn-north-4") 请替换为您要访问的MSGSMS平台所在区域，当前MSGSMS支持访问的区域，在SDK代码region.go中已经定义。 您可以在MSGSMS控制台页面左上角查看当前服务所在区域名称。 项目源码及更多详细的使用指导请参考华为云Go软件开发工具包（Go SDK）。 推荐您使用API在线调试工具API Explorer ，API Explorer支持快速调试和检索，调试API的同时，可以根据您的参数实时生成各种开发语言的SDK示例代码，方便您直接根据示例代码使用SDK。

开发前准备 已 注册华为账号 并开通华为云，完成企业实名认证。 已开通华为云MSGSMS服务。 已具备Java开发环境 ，支持Java JDK 1.8及以上版本。 已获取应用的Application Key(app_key)和Application Secret(app_secret)。 请在华为云控制台“应用管理”页面上创建和查看您的Application Key和Application Secret。具体请参见应用管理。 已获取您要发送短信的通道号。 由于通道号与签名关联，请在华为云控制台“签名管理”页面上查看您的通道号，如果您还没有通道号，则您需要先提交签名申请，待签名申请通过后，系统会分配通道号。具体请参见签名管理。 已获取您要发送短信的模板ID。 请在华为云控制台“模板管理”页面上创建和查看您的模板ID。具体请参见模板管理。

运行结果 发送短信（BatchSendSms） ```json class BatchSendSmsResponse { code: 000000 description: Success result: [class SmsID { createTime: 2024-11-22T02:16:46Z from: 8824110605*** originTo: +86137****3774 smsMsgId: eb4e63dd-0945-4231-a48d-6b54c1a8b614_3434030 status: 000000 countryId: CN total: 1 }, class SmsID { createTime: 2024-11-22T02:16:46Z from: 8824110605*** originTo: +86137****3776 smsMsgId: eb4e63dd-0945-4231-a48d-6b54c1a8b614_3434031 status: 000000 countryId: CN total: 1 }] } ``` 发送分批短信（BatchSendDiffSms） ```json class BatchSendDiffSmsResponse { code: 000000 description: Success result: [class SmsID { createTime: 2024-11-22T02:16:46Z from: 8824110605*** originTo: +86137****3774 smsMsgId: eb4e63dd-0945-4231-a48d-6b54c1a8b614_3435044 status: 000000 countryId: CN total: 0 }, class SmsID { createTime: 2024-11-22T02:16:46Z from: 8824110605*** originTo: +86137****3775 smsMsgId: eb4e63dd-0945-4231-a48d-6b54c1a8b614_3435045 status: 000000 countryId: CN total: 0 }, class SmsID { createTime: 2024-11-22T02:16:46Z from: 8824110605*** originTo: +86137****3777 smsMsgId: eb4e63dd-0945-4231-a48d-6b54c1a8b614_3435046 status: 000000 countryId: CN total: 1 }, class SmsID { createTime: 2024-11-22T02:16:46Z from: 8824110605*** originTo: +86137****3778 smsMsgId: eb4e63dd-0945-4231-a48d-6b54c1a8b614_3435047 status: 000000 countryId: CN total: 1 }] } ```

实例化 表1 实例化参数 参数名 参数类型 是否必选 参数描述 base_url str False 模型网关开放的ip和端口，有默认值可以不填。功能类似OpenAI的base_url。 custom_hearders dict False 其他自定义请求头信息。 http_client httpx.client False 自定义的httpx client。 kwargs - False 其他可选参数，如api_key、timeout等。

实例化 表1 实例化参数 参数名 参数类型 是否必选 参数描述 base_url str False 模型网关开放的IP和端口，有默认值可以不填。功能类似OpenAI的base_url。 custom_hearders dict False 其他自定义请求头信息。 http_client httpx.client False 自定义的httpx client。 kwargs - False 其他可选参数，如api_key、timeout等。

实例化 表1 实例化参数 参数名 参数类型 是否必选 参数描述 base_url str False 模型网关开放的ip和端口，有默认值可以不填。功能类似OpenAI的base_url。 custom_hearders dict False 其他自定义请求头信息。 http_client httpx.client False 自定义的httpx client。 kwargs - False 其他可选参数，如api_key、timeout等。

运维中心SDK类型介绍 运维中心为开发者提供访问凭证管理服务（Access Credential Management Service，简称ACMS）、服务发现（NUWA Cloud Map，简称Cloud Map）、负载均衡（Software/Server Load Balancer，简称SLB）和数据库治理（WiseDBA）的SDK，方便开发者将运维中心的能力快速集成到自己的应用中。 表1 SDK列表 SDK分类 说明 编程语言 下载地址 参考文档 ACMS的SDK：STS SDK STS SDK（Security Token Service，简称STS）服务软件开发工具包是对访问凭据管理服务（ACMS）提供的REST API进行的封装，以简化用户的开发工作。用户直接调用SecurityTokenService SDK提供的接口函数即可实现使用ACMS业务能力的目的。 使用STS SDK即可使用运维中心ACMS的敏感配置项托管和微服务之间请求认证功能。 Java nuwa-open-sdk-1.1.0-20240204093135.zip 完整性校验nuwa-open-sdk-1.1.0-20240204093135.zip.sha256 下载包nuwa-open-sdk-1.1.0-20240204093135.zip中的文件介绍请参见表2。 STS SDK Cloud Map的SDK：Cloud Map SDK Cloud Map SDK服务软件开发工具包是对服务发现（Cloud Map）服务提供的REST API进行的封装，以简化用户的开发工作。用户直接调用Cloud Map SDK提供的接口函数即可实现使用Cloud Map服务业务能力的目的。 Java Cloud Map SDK SLB的SDK：Gray SDK Gray SDK负责业务的负载均衡，Nginx组件通过反向代理实现了业务的负载均衡，通过丰富的扩展功能，可以对HTTP消息定制丰富的控制策略。 使用Gray SDK即可使用运维中心负载均衡（SLB）的灰度管理功能。 Java Gray SDK WiseDBA的SDK：Rainbow SDK Rainbow SDK构建云原生DevOps全流程可信build-in的数据库治理解决方案。使用Rainbow SDK即可使用运维中心的数据库治理（WiseDBA）功能。 提供MySQL/Cassandra/ GaussDB /DRDS全流程设计、开发、发布、运维（管理、治理、诊断）方案。 可信build-in：过程可信，结果可信，接入安全（无人工接入密码），操作（资源高危操作）安全。 Java Rainbow SDK 表2 SDK jar包介绍 文件夹 SDK分类 对应的jar包 nuwa-cse-sdk：适用于基于NUWA框架且不使用spring boot的项目 STS SDK sts-key-sdk-1.1.17.109.jar sts-sdk-base-1.1.17.109.jar cloudsoa-security-1.1.13.100.jar Cloud Map SDK nuwa-cloudmap-config-servicecomb-1.0.12.100.jar nuwa-cloudmap-core-1.0.12.100.jar nuwa-cloudmap-registry-cse3-1.0.12.100.jar nuwa-cloudmap-registry-servicecomb-common-1.0.12.100.jar Gray SDK graysdk-core-1.4.14.500.jar graysdk-cse3-1.4.14.500.jar nuwa-apaas-graysdk-3.1.5.100.jar Rainbow SDK rainbow-proxy-1.2.18.102.jar gpaas-middleware-common-2.2.6.100.jar NUWA基础SDK nuwa-boot-container-3.1.5.100.jar nuwa-core-3.1.5.100.jar nuwa-cse-foundation-3.1.5.100.jar nuwa-share-libs-3.1.5.100.jar nuwa-tenant-sdk-3.1.5.100.jar spring-cloud-sdk：适用于基于Spring Cloud框架的项目 STS SDK sts-key-sdk-1.1.19.100.jar sts-sdk-base-1.1.19.100.jar sts-spring-boot-1.1.19.100.jar cloudsoa-security-1.1.14.101.jar Cloud Map SDK nuwa-cloudmap-core-1.0.12.100.jar nuwa-cloudmap-spring-boot-starter-1.0.12.100.jar spring-cloud-starter-cloudmap-discovery-1.0.12.100.jar Gray SDK 不支持 Rainbow SDK gpaas-jetcd-api-2.0.0.106.jar gpaas-jetcd-v2-2.0.0.106.jar gpaas-middleware-common-2.2.6.100.jar nuwa-gpaas-rainbowproxy-3.2.2.100.jar nuwa-rainbowproxy-spring-boot-starter-3.2.2.100.jar rainbow-api-1.2.18.201.jar rainbow-core-1.2.18.201.jar rainbow-core-drds-1.2.18.201.jar rainbow-core-gaussdb-1.2.18.201.jar rainbow-proxy-1.2.18.201.jar NUWA基础SDK nuwa-boot-container-3.2.2.100.jar nuwa-core-3.2.2.100.jar nuwa-core-spring-boot-starter-3.2.2.100.jar spring-cse-sdk：适用于基于NUWA框架且使用spring boot的项目 STS SDK sts-key-sdk-1.1.19.100.jar sts-sdk-base-1.1.19.100.jar sts-spring-boot-1.1.19.100.jar cloudsoa-security-1.1.14.101.jar Cloud Map SDK nuwa-cloudmap-config-servicecomb-1.0.12.100.jar nuwa-cloudmap-core-1.0.12.100.jar nuwa-cloudmap-registry-cse3-1.0.12.100.jar nuwa-cloudmap-registry-servicecomb-common-1.0.12.100.jar nuwa-cloudmap-spring-boot-starter-3.2.2.100.jar nuwa-gpaas-cloudmap-3.2.2.100.jar Gray SDK graysdk-core-1.4.14.500.jar graysdk-cse3-1.4.14.500.jar nuwa-apaas-graysdk-3.2.2.100.jar nuwa-graysdk-spring-boot-starter-3.2.2.100.jar Rainbow SDK nuwa-gpaas-rainbowproxy-3.2.2.100.jar nuwa-rainbowproxy-spring-boot-starter-3.2.2.100.jar rainbow-proxy-1.2.18.102.jar gpaas-middleware-common-2.2.6.100.jar NUWA基础SDK nuwa-boot-container-3.2.2.100.jar nuwa-core-3.2.2.100.jar nuwa-core-spring-boot-starter-3.2.2.100.jar nuwa-cse-foundation-3.2.2.100.jar nuwa-cse-foundation-spring-boot-starter-3.2.2.100.jar nuwa-tenant-sdk-3.2.2.100.jar tools：configparser为自定义参数解析工具，通过NUWA部署时，解析参数模板，将模板中的参数变量，替换为实际的配置项值，具体使用方式请参见使用configparser工具优化代码。 -

AI原生应用引擎SDK介绍 AI原生应用引擎面向开发者提供了一套搭建原生应用的Python SDK，包含了模型调用，知识获取，工具调用等功能。开发者可以使用SDK调用AI原生应用引擎的各种能力，快速构建大模型应用。 AI原生应用引擎SDK获取地址：wiseagent-dev-sdk-python。您也可以参考下载SDK获取AI原生应用引擎SDK并进行完整性校验。 AI原生应用引擎SDK参考文档：AI原生应用引擎SDK API。

接口调用 PromptTemplate.from_template 初始化提示语模板，支持两种占位符格式以及部分变量值的预先填入。 参数说明 表2 参数说明 参数名称 参数类型 是否必选 参数描述 template str True 提示语模板。 template_format str False 提示语模板格式，支持f-string、jinja2两种。默认f-string。 partial_variable dict False 格式化模板的部分变量。 返回值：PromptTemplate object

类属性 表1 类属性 参数名 参数类型 是否必选 参数描述 input_variables List[str] True 提示语模板所需的变量名称列表 template str True 提示语模板 template_format str True 提示语模板格式，支持f-string、jinja2两种。默认f-string partial_variable dict False 格式化模板的部分变量 validate_template bool False 是否尝试验证模板

操作步骤 申请注册Huawei ID账号（已有华为ID账号跳过此步）。 注册链接：华为云，打开后单击“注册”，填写完整信息。 图1 注册HuaweiID账号 访问OrgID服务，创建OrgID组织。 单击“创建组织”，填写组织信息。 单击“进入控制台”，进入控制台。 在OrgID管理中心创建自身对接Demo应用信息。 进入控制台单击刚创建好的组织即可进入业务侧管理中心，或直接访问管理中心。 选择“应用管理”，单击右上角的“添加自建应用”。 图2 添加自建应用 填写应用信息，上传应用图标，选择Oauth协议。 图3 添加自建应用 配置Demo应用信息。 表1 应用配置参数说明 参数 说明 首页URL Oauth登录交互流程的回调地址。 管理员登录URL 如果Demo应用区分管理员角色，且登录后为管理后台，可自行配置。 退出地址 OrgID退出登录时，通知应用的回调接口。 Token有效期 OrgID侧会话最长时间，默认两小时。 图4 应用参数配置 授权登录用户。 在应用管理页面选择“授权管理”，单击“授权设置”。 图5 授权设置 自行选择授权范围。 图6 选择授权范围 查看创建好的Demo应用配置密钥。 在应用管理页面，选择“通用配置”，复制接口认证凭证。 接口认证凭证为OrgID侧生成的应用密钥，请开发者妥善保管。 图7 查看应用密钥 修改Demo工程的应用配置信息。 将application.yml.tmpl中的clientSecret配置为创建好的应用凭证信息，同时将login.html中的按钮登录链接改为已创建好的应用的登录链接，链接地址如图8所示。 图8 查看应用的登录链接 修改完成后，启动工程，访问首页登录地址。 通过“域名+端口号+/login”访问首页地址，单击“登录”跳转OrgID登录页，输入账号后，可成功跳转登录后的首页地址。

响应示例 { "server_group": { "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9", "name": "test", "policies": ["anti-affinity"], "members": [], "metadata": {} } }

响应消息 响应参数如表2所示。 表2 响应参数 参数 参数类型 描述 server_group Object 弹性云服务器组信息，参考表3 server_group参数信息。 表3 server_group参数信息 参数 参数类型 描述 id String 弹性云服务器组UUID。 name String 弹性云服务器组名称。 policies Array of strings 弹性云服务器组类型。 members Array of strings 弹性云服务器组中包含的弹性云服务器的ID列表。 metadata Object 弹性云服务器组元数据。

响应示例 响应示例请参见 响应（批量操作类）所示。 { "response": [ { "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" }, { "id": "516fb98f-46ca-475e-917e-2563e5a8cd12" } ] }

请求消息 请求参数如表2所示。 表2 请求参数 参数 参数类型 是否必选 描述 name String 是 弹性云服务器修改后的名称。 规则如下： 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成，且长度为[1-128]个英文字符或[1-64]个中文字符。 批量修改弹性云服务器名称时，名不会自动按序增加数字尾缀。例如： 三个E CS 的名称为test_0001，test_0002，test_0003，批量修改弹性云服务器名称为develop，则修改后3个弹性云服务器名称为develop，develop，develop。 dry_run Boolean 否 是否只预检此次请求。 true：发送检查请求，不会修改云服务器名称。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回正常响应信息。 响应结构请参见 7.5.1 响应 所示。 false：发送正常请求，通过检查后并且执行修改云服务器名称的请求。 默认值：false servers Array of objects 是 待修改的弹性云服务器ID信息，详情请参见 表3。 表3 servers字段数据结构说明 参数 参数类型 是否必选 描述 id String 是 弹性云服务器ID。

请求示例 批量修改ID为“260a0917-f7df-4b25-93ac-950da6c6b5d6”和“f6d8df1a-e257-48e2-b617-1dd92ced8c20”的云服务器的名称为“new-server-name”。 PUT https://{endpoint}/v1/{project_id}/cloudservers/server-name { "name": "new-server-name", "dry_run": false, "servers": [ { "id":"260a0917-f7df-4b25-93ac-950da6c6b5d6" }, { "id":"f6d8df1a-e257-48e2-b617-1dd92ced8c20" } ] }

操作步骤 创建网卡。 创建网络。 接口相关信息 URI格式：POST /v1/{project_id}/vpcs 详情请参见创建网络。 请求示例 POST https://{Endpoint}/v1/{project_id}/vpcs {endpoint}信息请从地区和终端节点获取。 Body： { "vpc": { "name": "vpc", "description": "test", "cidr": "192.168.0.0/16" } } 响应示例 { "vpc": { "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name": "vpc", "description": "test", "cidr": "192.168.0.0/16", "status": "CREATING", "routes": [] } } 记录响应中“vpc”的ID。 创建子网。 接口相关信息 URI格式：POST /v2.0/subnets 详情请参见创建子网。 请求示例 POST https://{endpoint}/v2.0/subnets {endpoint}信息请从地区和终端节点获取。 Body： { "subnet": { "name": "testsubnet", "enable_dhcp": true, "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", "tenant_id": "74610f3a5ad941998e91f076297ecf27", "dns_nameservers": [ "8.8.8.8", "8.8.8.7" ], "allocation_pools": [ { "start": "10.0.10.2", "end": "10.0.10.254" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "10.0.10.1", "cidr": "10.0.10.0/24" } } 响应示例 { "subnet": { "name": "testsubnet", "cidr": "10.0.10.0/24", "id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", "enable_dhcp": true, "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", "tenant_id": "74610f3a5ad941998e91f076297ecf27", "dns_nameservers": [ "8.8.8.8", "8.8.8.7" ], "allocation_pools": [ { "start": "10.0.10.2", "end": "10.0.10.254" } ], "host_routes": [], "ip_version": 4, "gateway_ip": "10.0.10.1" } } 记录响应中“subnet”的ID。 创建端口。 接口相关信息 URI格式：POST /v2.0/ports 详情请参见创建端口。 请求示例 POST https://{endpoint}/v2.0/ports {endpoint}信息请从地区和终端节点获取。 Body： { "port": { "admin_state_up": true, "fixed_ips": [ { "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5" } ], "name": "test", "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", "tenant_id": "74610f3a5ad941998e91f076297ecf27" } } 响应示例 { "port": { "id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4", "name": "test", "status": "DOWN", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", "ip_address": "10.0.10.233" } ], "mac_address": "fa:16:3e:db:91:f6", "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", "tenant_id": "74610f3a5ad941998e91f076297ecf27", "device_id": "", "device_owner": "", "security_groups": [ "93031677-2895-4b83-855a-637e309aa9e6" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {} } } 记录响应中“port”的ID。 挂载网卡。 接口相关信息 URI格式：POST /v1/{project_id}/cloudservers/{server_id}/nics 详情请参见“批量添加云服务器网卡”。 请求示例 POST https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers/9f4d9281-95e7-4915-a126-1ee597101e2e/nics {endpoint}信息请从地区和终端节点获取。 Body： { "nics": [ { "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5" } ] } 响应示例 { "job_id": "ff80808288d41e1b018990260955686a" } 确认挂载结果。 接口相关信息 URI格式：GET /v1/{project_id}/cloudservers/{server_id}/os-interface 详情请参见查询云服务器网卡信息。 请求示例 GET https://{endpoint}/v1/74610f3a5ad941998e91f076297ecf27/cloudservers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-interface {endpoint}信息请从地区和终端节点获取。 响应示例 { "interfaceAttachments": [ { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "46712fe4-25bd-4eae-874b-a528abfb76be", "ip_address": "192.168.0.50" } ], "net_id": "17251a8f-a671-4d7c-85d9-af5415962994", "port_id": "dd706739-b696-40be-a9f4-477ce478cb18", "mac_addr": "fa:16:3e:a5:e0:3c" }, { "port_state": "ACTIVE", "fixed_ips": [ { "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", "ip_address": "10.0.10.233" } ], "net_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4", "mac_addr": "fa:16:3e:db:91:f6" } ] }

API风格说明 当前ECS服务对外开放两类风格的API： ECS服务自定义规范的API（以下简称ECS API） 顺从OpenStack社区标准原生规范的API 两种风格不同，功能相近。OpenStack风格API主要用于满足您在开源生态工具方面的对接需求，在某些功能上ECS API在OpenStack社区的API基础上，做了功能增强。为了更好地使用OpenStack风格API，建议您提前了解OpenStack相关概念与知识。

微版本号介绍 微版本说明：标识API中小的改动。当接口URI使用v2.1版本的时候，用户可以指定微版本号使用相应API的新功能。使用查询API版本信息列表（废弃），可以查询当前支持的主版本和支持的最大与最小的微版本。 微版本的使用说明：用户想要使用微版本特性，需要在请求Openstack接口时，在请求头中加入微版本头：X-OpenStack-Nova-API-Version或者Openstack-API-Version，例如使用微版本2.26需要在https的请求头中加入： X-OpenStack-Nova-API-Version: 2.26或Openstack-API-Version: compute 2.26 当用户使用v2.1接口不传入微版本头时，默认使用的微版本Openstack-API-Version: compute 2.1(X-OpenStack-Nova-API-Version: 2.1)。

微版本请求样例 假设使用弹性云服务器详情信息列表API接口查询"OS-EXT-SRV-ATTR:hostname"字段。 使用v2接口，不加微版本号 GET: https://{Endpoint}/v2/74610f3a5ad941998e91f076297ecf27/servers/detail 其中{Endpoint}为 IAM 的终端节点，请参考终端节点获取。 Headers: Content-Type application/json X-Auth-Token ${token} 响应消息体： { "servers": [ { "tenant_id": "74610f3a5ad941998e91f076297ecf27", "addresses": { "05d4fb93-84e5-4964-853b-32992ffef627": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.228", "version": 4 }, { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", "OS-EXT-IPS:type": "floating", "addr": "192.168.51.61", "version": 4 } ] }, "metadata": {}, "OS-EXT-STS:task_state": null, "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone":"az1-dc1", "links": [ { "rel": "self", "href": "https://None/v2.1/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" }, { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" } ], "OS-EXT-STS:power_state": 1, "id": "89c312bb-285a-4026-a237-d441908c2f9e", "os-extended-volumes:volumes_attached": [ { "id": "c70c4b8e-33bd-4d1f-ab16-14a5a38cdeaf" } ], "OS-EXT-SRV-ATTR:host": "pod05.test.01", "image": { "links": [ { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/1189efbf-d48b-46ad-a823-94b942e2a000" } ], "id": "1189efbf-d48b-46ad-a823-94b942e2a000" }, "OS-SRV-USG:terminated_at": null, "accessIPv4": "", "accessIPv6": "", "created": "2018-05-11T03:21:56Z", "hostId": "fc7a8ff86bac050f0d9454b1b078dcc97060e819acbf06f04c3e338f", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova012@7", "key_name": "id_rsa", "flavor": { "links": [ { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/flavors/s3.small.1" } ], "id": "s3.small.1" }, "security_groups": [ { "name": "default" } ], "config_drive": "", "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:instance_name": "instance-0016c624", "user_id": "f79791beca3c48159ac2553fff22e166", "name": "zt-test", "progress": 0, "OS-SRV-USG:launched_at": "2018-05-11T03:22:16.701600", "updated": "2018-05-11T03:22:51Z", "status": "ACTIVE" } ] } 结论：响应消息体中没有"OS-EXT-SRV-ATTR:hostname"字段。 使用v2.1接口，加微版本号 GET: https://{Endpoint}/v2.1/74610f3a5ad941998e91f076297ecf27/servers/detail 其中{Endpoint}为IAM的终端节点，请参考终端节点获取。 Headers: Content-Type application/json X-Auth-Token ${token} X-OpenStack-Nova-API-Version 2.26 响应消息体： { "servers": [ { "tenant_id": "74610f3a5ad941998e91f076297ecf27", "addresses": { "05d4fb93-84e5-4964-853b-32992ffef627": [ { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", "OS-EXT-IPS:type": "fixed", "addr": "192.168.0.228", "version": 4 }, { "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", "OS-EXT-IPS:type": "floating", "addr": "192.168.51.61", "version": 4 } ] }, "metadata": {}, "OS-EXT-STS:task_state": null, "description": "zt-test", "OS-EXT-SRV-ATTR:hostname": "zt-test", "OS-DCF:diskConfig": "MANUAL", "OS-EXT-AZ:availability_zone":"az-test-01", "links": [ { "rel": "self", "href": "https://None/v2.1/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" }, { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" } ], "OS-EXT-STS:power_state": 1, "id": "89c312bb-285a-4026-a237-d441908c2f9e", "os-extended-volumes:volumes_attached": [ { "delete_on_termination": true, "id": "c70c4b8e-33bd-4d1f-ab16-14a5a38cdeaf" } ], "locked": false, "OS-EXT-SRV-ATTR:kernel_id": "", "OS-EXT-SRV-ATTR:host":"pod05.test.01" , "OS-EXT-SRV-ATTR:ramdisk_id": "", "image": { "links": [ { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/1189efbf-d48b-46ad-a823-94b942e2a000" } ], "id": "1189efbf-d48b-46ad-a823-94b942e2a000" }, "accessIPv4": "", "OS-SRV-USG:terminated_at": null, "accessIPv6": "", "OS-EXT-SRV-ATTR:launch_index": 0, "created": "2018-05-11T03:21:56Z", "OS-EXT-SRV-ATTR:user_data": null, "hostId": "fc7a8ff86bac050f0d9454b1b078dcc97060e819acbf06f04c3e338f", "OS-EXT-SRV-ATTR:reservation_id": "r-pbqmaxer", "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda", "host_status": "UP", "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova012@7", "tags": [], "key_name": "id_rsa", "flavor": { "links": [ { "rel": "bookmark", "href": "https://None/74610f3a5ad941998e91f076297ecf27/flavors/s3.small.1" } ], "id": "s3.small.1" }, "security_groups": [ { "name": "default" } ], "config_drive": "", "OS-EXT-STS:vm_state": "active", "OS-EXT-SRV-ATTR:instance_name": "instance-0016c624", "user_id": "f79791beca3c48159ac2553fff22e166", "name": "zt-test", "progress": 0, "OS-SRV-USG:launched_at": "2018-05-11T03:22:16.701600", "updated": "2018-05-11T03:22:51Z", "status": "ACTIVE" } ] } 结论：响应消息体中有"OS-EXT-SRV-ATTR:hostname"字段。

版本号介绍 弹性云服务器所提供的接口分为ECS接口与OpenStack原生接口。推荐您使用ECS接口。 Openstack API可以使用v2和v2.1两个版本号，v2.1版本支持v2版本所有功能，且v2.1版本支持微版本。如果使用Openstack API推荐用户使用v2.1接口。 若使用v2版本的openstack API接口，只需要把对应的API接口URI中的v2.1版本号改为v2版本号即可。

微版本响应样例 如果“version”和“min_version”这两个值为空字符串，说明此endpoint不支持微版本。其中： version： 最大微版本号。 min_version：最小微版本号。 客户端应该指定最大和最小微版本范围内的微版本号去访问endpoint。客户端通过以下HTTP header指定微版本号： X-OpenStack-Nova-API-Version: 2.4 从微版本2.27开始，也可以用以下header指定微版本： Openstack-API-Version: compute 2.27 如下响应样例中支持的最大微版本为“2.14”，最小微版本为“2.1”： { "versions": [ { "id": "v2.0", "links": [ { "href": "http://openstack.example.com/v2/", "rel": "self" } ], "status": "SUPPORTED", "version": "", "min_version": "", "updated": "2011-01-21T11:33:21Z" }, { "id": "v2.1", "links": [ { "href": "http://openstack.example.com/v2.1/", "rel": "self" } ], "status": "CURRENT", "version": "2.14", "min_version": "2.1", "updated": "2013-07-23T11:33:21Z" } ] }

OpenStack原生接口说明 表2 OpenStack原生接口说明 类型 说明 查询API版本信息 查询API版本信息列表 查询指定API版本信息 生命周期管理 包括弹性云服务器的创建、删除、修改、查询等接口。 状态管理 包括弹性云服务器的开机、关机、重启、锁定/解锁定、变更/回退变更规格等接口。 网络管理 查询租户、弹性云服务器的网络等接口。 镜像管理 包括删除、查询镜像等接口。 当前镜像管理API已废弃，请使用 镜像服务 接口。 安全组管理 包括添加、移除、查询、创建、更新、删除安全组及安全组规则等接口。 规格管理 查询弹性云服务器的规格列表、详情等接口。 网卡管理 包括添加、删除、查询弹性云服务器的网卡等接口。 磁盘管理 包括弹性云服务器的挂载、卸载、查询等接口。 元数据管理 包括更新、设置、删除、查询、获取、修改弹性云服务器元数据等接口。 租户配额管理 查询租户配额。 密钥、密码管理 包括查询、创建、删除SSH密钥等接口。 云服务器组管理 包括创建、查询、删除云服务器组等接口。 云服务器操作管理 包括查询云服务器操作行为列表、通过请求ID查询云服务器行为。 云服务器控制台管理 获取弹性云服务器的控制台日志等接口。 可用区 查询可用区列表。 标签管理 包括弹性云服务器一维标签的创建、删除、查询等接口。 浮动IP管理 包括分配、移除、创建、查询、删除浮动IP等接口。 当前浮动IP管理的API已废弃，请使用对应的网络服务接口。 快照管理 包括创建、查询、删除快照等接口。 当前快照管理的API已废弃，请使用对应的存储服务接口。

ECS接口说明 表1 ECS接口说明 类型 说明 生命周期管理 包括弹性云服务器的创建、删除、查询等接口。 状态管理 包括弹性云服务器的变更规格、重装/切换操作系统等接口。 批量操作 包括批量启动、重启、关闭、修改弹性云服务器等接口。 规格管理 查询规格详情、规格的扩展信息等。 网卡管理 批量添加、删除弹性云服务器的网卡。 给弹性云服务器网卡绑定、解绑定私有IP地址。 磁盘管理 包括弹性云服务器的挂载、卸载、查询等接口。 元数据管理 包括更新云服务器元数据和删除云服务器指定元数据的接口 租户配额管理 查询租户的配额，包括配额限制、已使用配额等接口。 查询Job状态 对于创建/删除云服务器、云服务器批量操作和网卡操作等异步API，可以通过该接口查询任务的执行状态。 标签管理 包括弹性云服务器二维标签的添加、删除、查询等接口。 支持批量添加、删除操作。 密码管理 一键重置弹性云服务器密码。 FPGA逻辑文件管理 包括注册、删除、查询FPGA镜像等接口，用于FPGA加速型云服务器。 云服务器组管理 包括创建、删除云服务器组接口、云服务器组添加成员、删除成员接口。 智能购买组管理 包括创建、修改、删除、查询智能购买组等接口。 规格推荐管理 包括地域推荐接口。

使用流程 通过图1您可以了解如何在AI原生应用引擎创建数据集、创建微调任务、部署推理模型以及在线测试模型效果。 图1 模型调优流程 创建微调数据集 数据集是模型微调的基础，首先需要创建用于模型训练的数据集。 创建模型微调流水线 通过模型微调任务进行模型训练，微调任务结束后，将生成改进后的新模型。 部署模型 模型部署是通过为基座模型（即原模型）和微调后的新模型创建用于预测的模型服务的过程实现。 测试模型调优效果 在线测试微调后的模型（输入问题发起请求获取数据分析结果），可检验模型的准确性、可靠性及反应效果。 清除相应资源 对于不再需要使用的微调任务和模型服务，及时清除相应资源，避免不必要的扣费。

构建版本 在左侧导航栏选择“流水线管理”，进入“流水线管理”页面。 在“流水线管理”页面，选择已创建版本的版本号“24.12.0.1”，单击“关联流水线”，在“关联流水线”页面，根据界面提示单击“立即前往”新建流水线，如图3所示。 图3 新建流水线 在“流水线管理”页面，单击“新建流水线”。 配置基本信息参数，参数说明如表2所示，单击“下一步”，选择“空模板”，单击“确定”，进入“任务编排”页面。 表2 参数说明 参数名称 参数说明 取值示例 名称 输入流水线名称。 Pipeline01 所属项目 服务所在项目。缺省值，不可修改。 - 流水线源 选择代码源。 Repo 创建方式 支持图形化编排、YAML化编排 图形化编排 代码仓 选择已创建的代码仓库。 Repo01 默认分支 选择默认分支。 master 根据需要配置流水线，然后单击“保存”。 进入“流水线管理”页面，单击右上角“关联流水线”。 在“关联流水线”页面，勾选已新建和配置完成的流水线，单击“确定”。 在流水线列表中，单击已关联的流水线所在行“操作”列的“执行”，单击“确定”，流水线开始构建版本的发布软件包。