全部产品
Search
文档中心

开源大数据平台E-MapReduce:CreateApiTemplate - 创建API模板

更新时间:Dec 12, 2024

创建一个预定义的API模板,该模板包含了API的基本结构、请求方式、URL路径、请求参数和响应格式等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
emr:CreateApiTemplatecreate
*全部资源
*

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
TemplateNamestring

集群模板名字。

DATALAKE模板
ApiNamestring

API 名称,目前只支持创建集群 API 模板。取值范围:CreateCluster。

CreateCluster
Contentstring

集群模版内容。取值:创建集群 CreateCluster 的入参 JSON 化后的内容。

content
ResourceGroupIdstring

资源组 ID。

rg-acfmzabjyop****

参数 Content 值示例(JAVA 语言): `

CreateClusterRequest request = new CreateClusterRequest();

request.setRegionId("cn-beijing");

request.setClusterType("DATALAKE");

//创建集群其他参数...

String content = new Gson().toJson(request); `

返回参数

名称类型描述示例值
object

返回数据

TemplateIdstring

模板 ID(建议使用参数 TemplateId)。

at-41b4c6a0fc63****
RequestIdstring

请求 ID。

DD6B1B2A-5837-5237-ABE4-FF0C8944****
Successstring

模板 ID(待废弃)。

at-41b4c6a0fc63****

示例

正常返回示例

JSON格式

{
  "TemplateId": "at-41b4c6a0fc63****",
  "RequestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "Success": "at-41b4c6a0fc63****"
}

错误码

HTTP status code错误码错误信息描述
400ConflictParametersParameters that must not be used together. %s多个参数间存在冲突。
400IncompleteSignatureThe request signature is invalid.API请求签名不合法。
400InvalidActionThe action %s requested is invalid.不合法的Action。
400InvalidParameterThe specified parameter %s is not valid.参数错误。
400InvalidParameterValueThe input parameter %s is invalid or out of range.参数值超出范围。
400MissingActionThe action %s requested is missing.缺少Action参数
400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
400NotAuthorizedYou do not have permission to perform this action. %s没有权限。
400ThrottlingExceptionThe request was denied due to request throttling. %s限流。
404ResourceNotFoundThe resource not found by %s.请求的资源未找到。
500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
503ServiceFailureThe request has failed due to a temporary failure of %s service.依赖的阿里云其他服务不可用。
503ServiceUnavailableThe request has failed due to a temporary failure of the server.请求超时或者服务不可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史