详情页标题前

阿里云大数据开发治理平台 DataWorksUpdateDataServiceApi-云淘科技

详情页1

调用UpdateDataServiceApi更新数据服务API开发态的信息。

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String UpdateDataServiceApi

系统规定参数。取值:UpdateDataServiceApi

TenantId Long 10001

租户ID。您可登录DataWorks控制台,进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单 > 用户信息,获取租户ID。

ProjectId Long 10001

工作空间的ID。

ApiId Long 10000

API的ID。

RequestMethod Integer 0

API的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELTE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE。

ResponseContentType Integer 0

API的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML。

Timeout Integer 10000

超时时间,单位为毫秒(ms),取值范围为

(0, 30000]。
)

VisibleRangeInteger0

可见范围,可选枚举值包括0(工作空间)和1(私有)。

Protocols String 0,1

API协议,可选枚举值包括0(HTTP)和1(HTTPS)。支持多值,多个值之间使用英文逗号(,)分隔。

WizardDetails String {“isPagedResponse”:true,”wizardConnection”:{“connectionId”:122786,”tableName”:”person”},”wizardRequestParameters”:[{“columnName”:”id”,”defaultValue”:””,”exampleValue”:”1″,”isRequiredParameter”:true,”parameterDataType”:2,”parameterDescription”:””,”parameterName”:”id”,”parameterOperator”:0,”parameterPosition”:0}],”wizardResponseParameters”:[{“columnName”:”id”,”exampleValue”:”11″,”parameterDataType”:2,”parameterDescription”:””,”parameterName”:”id”}]}

向导API的详情,请参见GetDataServiceApi接口wizardDetails字段的JSON String。

ScriptDetails String {“isPagedResponse”:false,”script”:”select id as id1, name as name1 from person where id=${inputid}”,”scriptConnection”:{“connectionId”:122786,”tableName”:”person”},”scriptRequestParameters”:[{“defaultValue”:””,”exampleValue”:””,”isRequiredParameter”:true,”parameterDataType”:0,”parameterDescription”:””,”parameterName”:”inputid”,”parameterOperator”:0,”parameterPosition”:1}],”scriptResponseParameters”:[{“exampleValue”:””,”parameterDataType”:0,”parameterDescription”:””,”parameterName”:”id1″},{“exampleValue”:””,”parameterDataType”:0,”parameterDescription”:””,”parameterName”:”name1″}]}

脚本API的详情,请参见GetDataServiceApi接口scriptDetails字段的JSON String。

RegistrationDetails String {“failedResultSample”:”fail”,”registrationErrorCodes”:[{“errorCode”:”e1″,”errorMessage”:”msg1″,”errorSolution”:”sol1″},{“errorCode”:”e2″,”errorMessage”:”msg2″,”errorSolution”:”sol2″}],”registrationRequestParameters”:[{“columnName”:””,”defaultValue”:””,”exampleValue”:””,”isRequiredParameter”:true,”parameterDataType”:0,”parameterDescription”:””,”parameterName”:”id”,”parameterOperator”:0,”parameterPosition”:1},{“columnName”:””,”defaultValue”:”xx”,”exampleValue”:””,”isRequiredParameter”:true,”parameterDataType”:0,”parameterDescription”:””,”parameterName”:”cc”,”parameterOperator”:2,”parameterPosition”:2}],”serviceContentType”:1,”serviceHost”:”http://www.baidu.com”,”servicePath”:”/[uid]”,”serviceRequestBodyDescription”:”body”,”successfulResultSample”:”success”}

注册API的详情,请参见GetDataServiceApi接口registrationDetails字段的JSON String。

ApiPath String /test/2

API的路径。

ApiDescription String 测试API描述

API的描述信息。

ResourceGroupId Long 3242432423

独享资源组ID。

返回数据

名称

类型

示例值

描述

HttpStatusCode Integer 200

HTTP状态码。

Data Boolean true

更新API是否成功。

ErrorMessage String The connection does not exist.

错误信息。

RequestId String 0000-ABCD-EFG****

请求ID,一次请求的唯一标识。

ErrorCode String Invalid.Tenant.ConnectionNotExists

错误码。

Success Boolean true

调用是否成功。

示例

请求示例

http(s)://[Endpoint]/?Action=UpdateDataServiceApi
&TenantId=10001
&ProjectId=10001
&ApiId=10000
&RequestMethod=0
&ResponseContentType=0
&Timeout=10000
&VisibleRange=0
&Protocols=0,1
&WizardDetails={"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}
&ScriptDetails={"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}
&RegistrationDetails={"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}
&ApiPath=/test/2
&ApiDescription=测试API描述
&ResourceGroupId=3242432423
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml


    200
    true
    The connection does not exist.
    0000-ABCD-EFG****
    Invalid.Tenant.ConnectionNotExists
    true

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "HttpStatusCode" : 200,
  "Data" : true,
  "ErrorMessage" : "The connection does not exist.",
  "RequestId" : "0000-ABCD-EFG****",
  "ErrorCode" : "Invalid.Tenant.ConnectionNotExists",
  "Success" : true
}

错误码

HttpCode

错误码

错误信息

描述

429 Throttling.Api The request for this resource has exceeded your available limit. 对该资源的请求已超过您的可用上限。
429 Throttling.System The DataWorks system is busy. Try again later. DataWorks系统繁忙,请稍后再试。
429 Throttling.User Your request is too frequent. Try again later. 您的请求过于频繁,请尝试放缓请求速度。
500 InternalError.System An internal system error occurred. Try again later. 系统内部错误,请稍后再试。
500 InternalError.UserId.Missing An internal system error occurred. Try again later. 系统内部错误,请稍后再试。

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

内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家

阿里云企业补贴进行中: 马上申请

腾讯云限时活动1折起,即将结束: 马上收藏

同尘科技为腾讯云授权服务中心。

购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠

转转请注明出处:https://www.yunxiaoer.com/171198.html

(0)
上一篇 2023年12月10日
下一篇 2023年12月10日
详情页2

相关推荐

  • 腾讯云对象存储图片质量评分

    简介 本文档提供关于图片质量评分的 API 概览和 SDK 示例代码。 API 操作描述 图片质量评分 对图片文件进行检测,从多方面评估,最终给出综合可观的清晰度评分和主观的美观度评分。 图片质量评分 功能说明 图片质量评分功能为同步请求方式,您可以通过本接口对图片文件进行检测,从多方面评估,最终给出综合可观的清晰度评分和主观的美观度评分。该接口属于 GET…

    腾讯云 2023年12月9日
  • 阿里云对象存储OSS0003-00000502-云淘科技

    问题描述 请求被防盗链策略(Referer Bucket)拒绝。 问题原因 您发起的请求请求头中Referer字段的值在Bucket Referer黑名单中。 问题示例 比如您访问的Bucket的Referer配置如下: false http://*.aliyuncs.com http://abc.aliyuncs.com </RefererConfi…

    阿里云对象存储 2023年12月10日
  • 腾讯云对象存储盲水印

    简介 本文档提供关于盲水印的相关的 API 概览以及 SDK 示例代码。关于盲水印 API 文档请参见 盲水印。 添加盲水印 功能说明 盲水印支持在上传时添加和下载时添加。 示例代码一:上传时添加盲水印 const filePath = “temp-file-to-upload” // 本地文件路径cos.putObject({ Bucket: ‘examp…

    腾讯云 2023年12月9日
  • 信息流广告,信息流部分建议宽度830px,只针对默认列表样式,顺序随机
  • 阿里云大数据开发治理平台 DataWorksGetMetaTableChangeLog-云淘科技

    调用GetMetaTableChangeLog获取表的变更日志。不建议使用该API,后续将有新API上线覆盖此功能。 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 Ge…

  • 腾讯云对象存储查询对象元数据

    简介 本文档提供关于查询对象元数据操作相关的 API 概览以及 SDK 示例代码。 API 操作名 操作描述 HEAD Object 查询对象元数据 查询对象的元数据信息 查询对象元数据 功能说明 查询 Object 的 Meta 信息(HEAD Object)。 方法原型 public Guzzle\Service\Resource\Model headO…

    腾讯云 2023年12月9日

联系我们

400-800-8888

在线咨询: QQ交谈

邮件:admin@example.com

工作时间:周一至周五,9:30-18:30,节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买,续费优惠,保证底价,买贵退差。