全部产品
Search

搜索本产品

    大数据开发治理平台 DataWorks：UpdateDataServiceApi - 更新数据服务API开发态的信息

    文档中心

    大数据开发治理平台 DataWorks：UpdateDataServiceApi - 更新数据服务API开发态的信息

    更新时间：Nov 15, 2024

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

    调试

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

    授权信息

    当前API暂无授权信息透出。

    请求参数

    名称类型必填描述示例值
    TenantIdlong否

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

    		10001
    ProjectIdlong是

    工作空间的 ID。

    		10001
    ApiIdlong是

    API 的 ID。

    		10000
    RequestMethodinteger是

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

    		0
    ResponseContentTypeinteger是

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

    		0
    Timeoutinteger是

    超时时间，单位为毫秒（ms），取值范围为(0, 30000]。

    		10000
    VisibleRangeinteger是

    可见范围，可选枚举值包括 0（工作空间）和 1（私有）。

    		0
    Protocolsstring是

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

    		0,1
    WizardDetailsstring否

    向导 API 的详情，请参见 GetDataServiceApi 接口 wizardDetails 字段的 JSON 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"}]}
    ScriptDetailsstring否

    脚本 API 的详情，请参见 GetDataServiceApi 接口 scriptDetails 字段的 JSON 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"}]}
    RegistrationDetailsstring否

    注册 API 的详情，请参见 GetDataServiceApi 接口 registrationDetails 字段的 JSON 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"}
    ApiPathstring是

    API 的路径。

    		/test/2
    ApiDescriptionstring是

    API 的描述信息。

    		测试API描述
    ResourceGroupIdlong否

    独享资源组 ID。

    		3242432423

    返回参数

    名称类型描述示例值
    object
    HttpStatusCodeinteger

    HTTP 状态码。

    		200
    Databoolean

    更新 API 是否成功。

    		true
    ErrorMessagestring

    错误信息。

    		The connection does not exist.
    RequestIdstring

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

    		0000-ABCD-EFG****
    ErrorCodestring

    错误码。

    		Invalid.Tenant.ConnectionNotExists
    Successboolean

    调用是否成功。

    		true

    示例

    正常返回示例

    JSON格式

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

    错误码

    HTTP status code错误码错误信息描述
    403Forbidden.AccessAccess is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.没有权限，请授权
    429Throttling.ApiThe request for this resource has exceeded your available limit.对该资源的请求已超过您的可用上限。
    429Throttling.SystemThe DataWorks system is busy. Try again later.DataWorks系统繁忙，请稍后再试。
    429Throttling.UserYour request is too frequent. Try again later.您的请求过于频繁，请尝试放缓请求速度。
    500InternalError.SystemAn internal system error occurred. Try again later.系统内部错误，请稍后再试。
    500InternalError.UserId.MissingAn internal system error occurred. Try again later.系统内部错误，请稍后再试。

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

    变更历史

    变更时间变更内容概要操作
    2023-10-09OpenAPI 错误码发生变更查看变更详情
    2023-03-02OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情