计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive

通过AK/SK认证的方式访问在线服务

更新时间:2024-11-22 GMT+08:00

如果在线服务的状态处于“运行中”,则表示在线服务已部署成功。部署成功的在线服务,将为用户提供一个可调用的API,此API为标准Restful API。用户可以通过AK/SK签名认证方式调用API。

使用AK/SK认证时,您可以通过APIG SDK访问,也可以通过ModelArts SDK访问。使用ModelArts SDK访问参见用户AK-SK认证模式。本文档详细介绍如何通过APIG SDK访问在线服务,具体操作流程如下:

  1. 获取AK/SK
  2. 获取在线服务信息
  3. 发送预测请求
说明:
  1. AK/SK签名认证方式,仅支持Body体12M以内,12M以上的请求,需使用Token认证。
  2. 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。因为API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时间差超过15分钟,API网关将拒绝请求。

约束限制

调用API访问在线服务时,对预测请求体大小和预测时间有限制:
  • 请求体的大小不超过12MB,超过后请求会被拦截。
  • 因APIG(API网关)限制,平台每次请求预测的时间不超过40秒。

获取AK/SK

如果已生成过AK/SK,则可跳过此步骤,找到原来已下载的AK/SK文件,文件名一般为:credentials.csv。

如下图所示,文件包含了租户名(User Name),AK(Access Key Id),SK(Secret Access Key)。

图1 credential.csv文件内容
AK/SK生成步骤:
  1. 注册并登录管理控制台。
  2. 单击右上角的用户名,在下拉列表中单击“我的凭证”。
  3. 单击“访问密钥”。
  4. 单击“新增访问密钥”,进入“身份验证”页面。
  5. 根据提示完成身份验证,下载密钥,并妥善保管。

获取在线服务信息

在调用接口时,需获取在线服务的调用地址,以及在线服务的输入参数信息。步骤如下:

  1. 登录ModelArts管理控制台,在左侧导航栏中选择“模型部署 > 在线服务”,默认进入“在线服务”列表。
  2. 单击目标服务名称,进入服务详情页面。
  3. “在线服务”的详情页面,可以获取该服务的调用地址和输入参数信息。
    “API接口公网地址”即在线服务的调用地址。当模型配置文件中apis定义了路径,调用地址后需拼接自定义路径。如:“{在线服务的调用地址}/predictions/poetry”。
    图2 获取在线服务API接口地址和文件预测输入参数信息

方式一:使用Python语言发送预测请求

  1. 下载Python SDK并在开发工具中完成SDK配置。具体操作请参见在Python环境中集成API请求签名的SDK
  2. 创建请求体,进行预测请求。
    • 输入为文件格式
      # coding=utf-8
      
      import requests
      import os
      from apig_sdk import signer
      
      if __name__ == '__main__':
          # Config url, ak, sk and file path.
          url = "在线服务的调用地址"
          # 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;
          # 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
          ak = os.environ["HUAWEICLOUD_SDK_AK"]
          sk = os.environ["HUAWEICLOUD_SDK_SK"]
          file_path = "预测文件的本地路径"
      
          # Create request, set method, url, headers and body.
          method = 'POST'
          headers = {"x-sdk-content-sha256": "UNSIGNED-PAYLOAD"}
          request = signer.HttpRequest(method, url, headers)
      
          # Create sign, set the AK/SK to sign and authenticate the request.
          sig = signer.Signer()
          sig.Key = ak
          sig.Secret = sk
          sig.Sign(request)
      
          # Send request
          files = {'images': open(file_path, 'rb')}
          resp = requests.request(request.method, request.scheme + "://" + request.host + request.uri, headers=request.headers, files=files)
      
          # Print result
          print(resp.status_code)
          print(resp.text)

      “file_path”为预测文件的本地路径,既可使用绝对路径(如Windows格式"D:/test.png",Linux格式"/opt/data/test.png"),也可以使用相对路径(如"./test.png")。

      “files”参数的请求体样式为“files={"请求参数":("文件路径",文件内容,“文件类型”)}”,参数填写可以参考表1
      表1 files参数说明

      参数

      是否必填

      说明

      请求参数

      在线服务输入参数名称。

      文件路径

      上传文件的路径。

      文件内容

      上传文件的内容。

      文件类型

      上传文件类型。当前支持以下类型:

      • txt类型:text/plain
      • jpg/jpeg类型:image/jpeg
      • png类型:image/png
    • 输入为文本格式(json类型)

      读取本地预测文件并进行base64编码的请求体示例如下:

      # coding=utf-8
      
      import base64
      import json
      import os
      import requests
      from apig_sdk import signer
      
      if __name__ == '__main__':
          # Config url, ak, sk and file path.
          url = "在线服务的调用地址"
          # 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;
          # 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。
          ak = os.environ["HUAWEICLOUD_SDK_AK"]
          sk = os.environ["HUAWEICLOUD_SDK_SK"]
          file_path = "预测文件的本地路径"
          with open(file_path, "rb") as file:
              base64_data = base64.b64encode(file.read()).decode("utf-8")
      
          # Create request, set method, url, headers and body.
          method = 'POST'
          headers = {
              'Content-Type': 'application/json'
          }
          body = {
              'image': base64_data
          }
          request = signer.HttpRequest(method, url, headers, json.dumps(body))
      
          # Create sign, set the AK/SK to sign and authenticate the request.
          sig = signer.Signer()
          sig.Key = ak
          sig.Secret = sk
          sig.Sign(request)
      
          # Send request
          resp = requests.request(request.method, request.scheme + "://" + request.host + request.uri, headers=request.headers, data=request.body)
      
          # Print result
          print(resp.status_code)
          print(resp.text)

      “body”中的参数名由在线服务的输入参数决定,需要和“类型”“string”的输入参数“名称”保持一致。此处以“image”为例。“body”中的base64_data值为string类型。

方式二:使用Java语言发送预测请求

  1. 下载Java SDK并在开发工具中完成SDK配置。
  2. 创建Java类,进行预测请求。

    由于在APIG的Java SDK中,“request.setBody()”只支持String类型,所以只支持输入为文本格式的预测请求。如果输入的是文件格式,需要先进行base64编码转换成文本。

    • 输入为文件格式
      此处以json格式为例介绍读取本地预测文件并进行base64编码的请求体,请求体示例如下:
      package com.apig.sdk.demo;
      import com.cloud.apigateway.sdk.utils.Client;
      import com.cloud.apigateway.sdk.utils.Request;
      import org.apache.commons.codec.binary.Base64;
      import org.apache.http.HttpHeaders;
      import org.apache.http.client.methods.CloseableHttpResponse;
      import org.apache.http.client.methods.HttpPost;
      import org.apache.http.client.methods.HttpRequestBase;
      import org.apache.http.impl.client.HttpClients;
      import org.apache.http.util.EntityUtils;
      import java.io.FileInputStream;
      import java.io.IOException;
      import java.io.InputStream;
      public class MyAkSkTest2 {
          public static void main(String[] args) {
              String url = "在线服务的调用地址";
             // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;
             // 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 
              String ak = System.getenv("HUAWEICLOUD_SDK_AK");
             String sk = System.getenv("HUAWEICLOUD_SDK_SK");
              String filePath = "预测文件的本地路径";
              try {
                  // Create request
                  Request request = new Request();
                  // Set the AK/SK to sign and authenticate the request.
                  request.setKey(ak);
                  request.setSecret(sk);
                  // Specify a request method, such as GET, PUT, POST, DELETE, HEAD, and PATCH.
                  request.setMethod(HttpPost.METHOD_NAME);
                  // Add header parameters
                  request.addHeader(HttpHeaders.CONTENT_TYPE, "application/json");
                  // Set a request URL in the format of https://{Endpoint}/{URI}.
                  request.setUrl(url);
                  // build your json body
                  String body = "{\"image\":\"" + getBase64FromFile(filePath) + "\"}";
                  // Special characters, such as the double quotation mark ("), contained in the body must be escaped.
                  request.setBody(body);
                  // Sign the request.
                  HttpRequestBase signedRequest = Client.sign(request);
                  // Send request.
                  CloseableHttpResponse response = HttpClients.createDefault().execute(signedRequest);
                  // Print result
                  System.out.println(response.getStatusLine().getStatusCode());
                  System.out.println(EntityUtils.toString(response.getEntity()));
              } catch (Exception e) {
                  e.printStackTrace();
              }
          }
          /**
           * Convert the file into a byte array and Base64 encode it
           * @return
           */
          private static String getBase64FromFile(String filePath) {
              // Convert the file into a byte array
              InputStream in = null;
              byte[] data = null;
              try {
                  in = new FileInputStream(filePath);
                  data = new byte[in.available()];
                  in.read(data);
                  in.close();
              } catch (IOException e) {
                  e.printStackTrace();
              }
              // Base64 encode
              return new String(Base64.encodeBase64(data));
          }
      }
      注意:

      使用base64编码方式,需要在模型推理代码中增加对请求体解码的代码。

    • 输入为文本格式(json类型)
      // Package name of the demo.
      package com.apig.sdk.demo;
      
      import com.cloud.apigateway.sdk.utils.Client;
      import com.cloud.apigateway.sdk.utils.Request;
      import org.apache.http.HttpHeaders;
      import org.apache.http.client.methods.CloseableHttpResponse;
      import org.apache.http.client.methods.HttpPost;
      import org.apache.http.client.methods.HttpRequestBase;
      import org.apache.http.impl.client.HttpClients;
      import org.apache.http.util.EntityUtils;
      
      public class MyAkSkTest {
      
          public static void main(String[] args) {
              String url = "在线服务的调用地址";
             // 认证用的ak和sk硬编码到代码中或者明文存储都有很大的安全风险,建议在配置文件或者环境变量中密文存放,使用时解密,确保安全;
             // 本示例以ak和sk保存在环境变量中来实现身份验证为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 
              String ak = System.getenv("HUAWEICLOUD_SDK_AK");
             String sk = System.getenv("HUAWEICLOUD_SDK_SK");
      
              try {
                  // Create request
                  Request request = new Request();
      
                  // Set the AK/SK to sign and authenticate the request.
                  request.setKey(ak);
                  request.setSecret(sk);
      
                  // Specify a request method, such as GET, PUT, POST, DELETE, HEAD, and PATCH.
                  request.setMethod(HttpPost.METHOD_NAME);
      
                  // Add header parameters
                  request.addHeader(HttpHeaders.CONTENT_TYPE, "application/json");
      
                  // Set a request URL in the format of https://{Endpoint}/{URI}.
                  request.setUrl(url);
      
                  // Special characters, such as the double quotation mark ("), contained in the body must be escaped.
                  String body = "{}";
                  request.setBody(body);
      
                  // Sign the request.
                  HttpRequestBase signedRequest = Client.sign(request);
      
                  // Send request.
                  CloseableHttpResponse response = HttpClients.createDefault().execute(signedRequest);
      
                  // Print result
                  System.out.println(response.getStatusLine().getStatusCode());
                  System.out.println(EntityUtils.toString(response.getEntity()));
              } catch (Exception e) {
                  e.printStackTrace();
              }
          }
      }

      “body”由具体文本格式决定,此处以json为例。

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容