应用与数据集成平台 ROMA CONNECT-调用开放的API:调用API
调用API
- 构造API请求,示例如下:
POST https://{Address}/{Path}?{Query} {Header} { {Body} }
- POST:请求方法,需替换为获取API的请求信息中获取的请求方法。
- {Address}:请求地址,需替换为获取API的请求信息中获取的 域名 地址。您也可以使用IP地址访问API,
API调用场景
API请求参数配置
使用域名调用API
ROMA Connect允许使用分组分配的子域名或分组绑定的域名调用API,无需另外配置。
使用IP调用DEFAULT分组的API
ROMA Connect允许使用IP地址调用DEFAULT分组下的API,无需另外配置。
使用IP调用非DEFAULT分组的API
- ROMA Connect的实例配置参数“app_route”已设置为“on”,允许通过IP访问API。
- ROMA Connect不允许使用IP地址直接调用非DEFAULT分组下的API,需要在请求消息中添加Header参数“X-HW-ID”,参数值为API所授权凭据的Key。
- {Path}:请求路径,需替换为获取API的请求信息中获取的URL。
- {Query}:查询参数,可选,格式为“参数名=参数取值”,例如limit=10,多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。
- {Header}:请求头参数,格式为“参数名: 参数取值”,例如Content-Type: application/json。需根据获取API的请求信息中获取的请求参数进行设置。
- {Body}:请求消息体,JSON格式。需根据获取API的请求信息中获取的请求体内容描述进行设置。
- 为API请求添加认证信息。
Site实例中不支持华为 IAM 认证。
API认证方式
API请求参数配置
APP认证(签名认证)
使用获取的SDK对API请求进行签名,具体请参考APP认证开发。
APP认证(简易认证)
在API请求中添加Header参数“X-Apig-AppCode”,参数值为获取API的认证信息中获取到的AppCode。
APP认证(绿色通道白名单)
在API请求中添加Header参数“X-HW-ID”,参数值为获取API的认证信息中获取到的Key。
APP认证(app_secret认证)
- ROMA Connect的实例配置参数“app_secret”已设置为“on”,开启app_secret认证。
- 在API请求中添加Header参数“X-HW-ID”,参数值为获取API的认证信息中获取到的Key。
- 在API请求中添加Header参数“X-HW-AppKey”,参数值为获取API的认证信息中获取到的Secret。
APP认证(app_basic认证)
- ROMA Connect的实例配置参数“app_basic”已设置为“on”,开启app_basic认证。
- 在API请求中添加Header参数“Authorization”,参数值为"Basic "+base64(appkey+":"+appsecret),其中appkey和appsecret分别为获取API的认证信息中获取到的Key和Secret。
APP认证(双重认证)
在API请求中同时携带APP认证和自定义认证的认证信息。
IAM认证(Token认证)
先获取云服务平台的认证Token,然后在API请求中添加Header参数“X-Auth-Token”,参数值为认证Token,具体请参考IAM认证开发(Token)。
IAM认证(AK/SK认证)
使用获取的SDK对API请求进行签名,具体请参考IAM认证开发(AK/SK)。
IAM认证(双重认证)
在API请求中同时携带IAM认证和自定义认证的认证信息。
自定义认证
根据自定义认证的定义,在API请求参数中携带相关认证信息进行认证。
无认证
无需认证,可直接调用API。
- 开放API_API开放流程_调用API-华为云
- 调用GaussDB(DWS) API接口_数据仓库服务调用API_如何调用API_在DWS中调用API
- 调用API_API调用流程_API网关APIG-华为云
- 手写识别api_识别图片文字api_文字识别api_调用_ocr
- API网关跨VPC开放后端服务_API开放后端服务_API网关APIG-华为云
- 使用API网关开放本地数据中心服务能力_开放API_API网关APIG-华为云
- 使用API网关开放云容器引擎CCE工作负载_开放API_API网关APIG-华为云
- 调用函数_函数调用方式_函数工作流 FunctionGraph-华为云
- API网关支持http到https自动重定向_开放API_API网关APIG-华为云
- API网关的策略_API网关的插件策略_APIG传统策略