UpdateDataServiceApi

UpdateDataServiceApi modifies development-stage information for data service APIs, including request methods, response types, timeouts, visibility, and protocols, ensuring API configurations align with project requirements in DataWorks MCP Server.

Instructions

更新数据服务API开发态的信息

Input Schema

Name	Required	Description
`ApiDescription`	Yes	API的描述信息
`ApiId`	No	API的ID
`ApiPath`	Yes	API的路径
`ProjectId`	No	工作空间的ID
`Protocols`	Yes	API协议，可选枚举值包括0（HTTP）和1（HTTPS）。支持多值，多个值之间使用英文逗号（,）分隔
`RegistrationDetails`	No	注册API的详情，请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString
`RequestMethod`	No	API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELTE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE
`ResourceGroupId`	No	独享资源组ID
`ResponseContentType`	No	API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML
`ScriptDetails`	No	脚本API的详情，请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString
`TenantId`	No	租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单>用户信息，获取租户ID
`Timeout`	No	超时时间，单位为毫秒（ms），取值范围为(0,30000]
`VisibleRange`	No	可见范围，可选枚举值包括0（工作空间）和1（私有）
`WizardDetails`	No	向导API的详情，请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "ApiDescription": {
      "description": "API的描述信息",
      "type": "string"
    },
    "ApiId": {
      "description": "API的ID"
    },
    "ApiPath": {
      "description": "API的路径",
      "type": "string"
    },
    "ProjectId": {
      "description": "工作空间的ID"
    },
    "Protocols": {
      "description": "API协议，可选枚举值包括0（HTTP）和1（HTTPS）。支持多值，多个值之间使用英文逗号（,）分隔",
      "type": "string"
    },
    "RegistrationDetails": {
      "description": "注册API的详情，请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString",
      "type": "string"
    },
    "RequestMethod": {
      "description": "API的请求方式，可选枚举值包括0（GET）、1（POST）、2（PUT）和3（DELTE）。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE"
    },
    "ResourceGroupId": {
      "description": "独享资源组ID"
    },
    "ResponseContentType": {
      "description": "API的返回数据类型，可选枚举值包括0（JSON）和1（XML）。向导和脚本API支持JSON，注册API支持JSON和XML"
    },
    "ScriptDetails": {
      "description": "脚本API的详情，请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString",
      "type": "string"
    },
    "TenantId": {
      "description": "租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console)，进入数据开发（DataStudio）页面，单击右上方当前登录用户名称，选择菜单>用户信息，获取租户ID"
    },
    "Timeout": {
      "description": "超时时间，单位为毫秒（ms），取值范围为(0,30000]"
    },
    "VisibleRange": {
      "description": "可见范围，可选枚举值包括0（工作空间）和1（私有）"
    },
    "WizardDetails": {
      "description": "向导API的详情，请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString",
      "type": "string"
    }
  },
  "required": [
    "Protocols",
    "ApiPath",
    "ApiDescription"
  ],
  "type": "object"
}

DataWorks MCP Server

UpdateDataServiceApi

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from DataWorks MCP Server

Related Tools

MCP directory API