{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-dataworks-public/abolish-cross-project-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_abolish_cross_project_pipeline_run","summary":"Stops a cross-workspace publish flow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","PipelineRunId"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"PipelineRunId":{"type":"string","description":"The ID of the cross-workspace publish flow"},"Reason":{"type":"string","description":"The reason for stopping the cross-workspace publish flow"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/abolish-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_abolish_pipeline_run","summary":"Calls this operation to change the status of a specified deployment process to terminated. The deployment…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can logon to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the deployment process"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/add-entity-into-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_add_entity_into_meta_collection","summary":"Adds a specified entity object to a Data Map collection. The collection object can be a Data Map category or…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MetaCollectionId","Id"],"properties":{"MetaCollectionId":{"type":"string","description":"The ID of the collection object. You can obtain the ID from the response of the ListMetaCollections operation"},"Id":{"type":"string","description":"The ID of the entity. Currently, only the table type is supported. You can obtain the ID from the response of the ListTables operation"},"Remark":{"type":"string","description":"The remarks when adding the entity to the collection. Currently, this parameter takes effect only for the album type"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/apply-resource-access-permission":{"post":{"operationId":"cloud_aliyun_dataworks_public_apply_resource_access_permission","summary":"Commits an access permissions request for specific resources","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Reason","ApplyContents"],"properties":{"Reason":{"type":"string","description":"The reason for the request"},"ApplyContents":{"type":"string","description":"The list of resource permission request entries (JSON-encoded)"},"ClientToken":{"type":"string","description":"The idempotency token. Used to prevent duplicate operations caused by multiple calls"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/approve-process-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_approve_process_instance","summary":"Approves or rejects a specified approval process instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProcessInstanceId","ApprovalComment","ApprovalAction"],"properties":{"ProcessInstanceId":{"type":"string","description":"The flow instance ID. Both new and legacy Security Center approval orders are supported"},"ApprovalComment":{"type":"string","description":"The approval comment"},"NewExpiration":{"type":"integer","description":"The modified authorization expiration time. The value is a millisecond-level timestamp"},"ApprovalAction":{"type":"string","description":"The approval action. Valid values: Agree: approves the request. Deny: rejects the request"},"ClientToken":{"type":"string","description":"The idempotency token. We recommend that you use a UUID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/associate-project-to-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_associate_project_to_image","summary":"Associates an image with a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId"],"properties":{"Id":{"type":"string","description":"The image ID"},"ProjectId":{"type":"integer","description":"The project ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/associate-project-to-resource-group":{"post":{"operationId":"cloud_aliyun_dataworks_public_associate_project_to_resource_group","summary":"Associates a resource group with a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId","ProjectId"],"properties":{"ResourceGroupId":{"type":"string","description":"The unique identifier of the resource group"},"ProjectId":{"type":"integer","description":"The ID of the workspace to associate with the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/batch-create-meta-entities":{"post":{"operationId":"cloud_aliyun_dataworks_public_batch_create_meta_entities","summary":"Creates metadata entities in batches. All entities in the same batch must be of the same type. Currently,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Entities"],"properties":{"Entities":{"type":"string","description":"The list of entities. A maximum of five entities are supported. All entities in the same batch must have the same entityType (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/batch-delete-meta-entities":{"post":{"operationId":"cloud_aliyun_dataworks_public_batch_delete_meta_entities","summary":"Deletes metadata entity objects in batches. Supports deleting custom entities and extension table type…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Ids"],"properties":{"Ids":{"type":"string","description":"The list of entity IDs to delete. A maximum of 10 IDs are supported. All entities in the same batch must be of the same entityType…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/batch-update-tasks":{"post":{"operationId":"cloud_aliyun_dataworks_public_batch_update_tasks","summary":"Updates multiple nodes in batches by using incremental updates","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Tasks":{"type":"string","description":"The list of nodes (JSON-encoded)"},"Comment":{"type":"string","description":"The remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/build-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_build_image","summary":"Builds an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ResourceGroupId"],"properties":{"Id":{"type":"string","description":"The image ID"},"ResourceGroupId":{"type":"string","description":"The unique identifier of the general-purpose resource group"},"ProcessId":{"type":"string","description":"The image build execution ID, which is used as an idempotence identifier"},"Cu":{"type":"number","description":"The number of compute units (CUs) used for the build"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/cancel-agent-session":{"post":{"operationId":"cloud_aliyun_dataworks_public_cancel_agent_session","summary":"Interrupts the Agent call for a specified session, supporting interruption during streaming responses","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. Fixed value: 2.0"},"Id":{"type":"string","description":"The ID passed in by the requester, returned as-is in the response"},"Params":{"type":"string","description":"The business parameters of the request (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/cancel-image-test":{"post":{"operationId":"cloud_aliyun_dataworks_public_cancel_image_test","summary":"Cancels an image test","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"},"ProcessId":{"type":"string","description":"The execution ID of the image test to cancel"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/clone-data-source":{"post":{"operationId":"cloud_aliyun_dataworks_public_clone_data_source","summary":"Clones an existing data source to create a new one","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","CloneDataSourceName"],"properties":{"Id":{"type":"integer","description":"The ID of the data source, which is the unique identifier of the data source. You can call the ListDataSources operation to query existing…"},"CloneDataSourceName":{"type":"string","description":"The name of the target data source. The name can contain letters, digits, and underscores (_), and cannot start with a digit or an…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-agent":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_agent","summary":"Creates an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the agent. The name must be unique within the current account"},"DisplayName":{"type":"string","description":"The display name of the agent"},"Description":{"type":"string","description":"The description of the agent"},"Model":{"type":"string","description":"The model configuration (JSON-encoded)"},"SystemPrompt":{"type":"string","description":"The system prompt"},"Tools":{"type":"string","description":"The list of tools (JSON-encoded)"},"Skills":{"type":"string","description":"The list of skills (JSON-encoded)"},"ExpertSuites":{"type":"string","description":"The published expert suites bound to the agent. For personal or enterprise suites, use SuiteId and optionally Version. For official…"},"CallableAgents":{"type":"string","description":"The list of sub-agents that can be called by this agent (JSON-encoded)"},"PublishImmediately":{"type":"string","description":"Specifies whether to publish the agent immediately after creation. A value of true publishes the created version. A value of false or…"},"Metadata":{"type":"string","description":"The extended metadata in key-value pairs (JSON-encoded)"},"Visibility":{"type":"string","enum":["TENANT","PROJECT","USER"],"description":"The visibility level. Valid values: `TENANT`: The agent is visible within the account. `PROJECT`: The agent is visible to specified…"},"VisibilityScope":{"type":"string","description":"The visibility scope. The corresponding fields are used based on the Visibility value (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-agent-session":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_agent_session","summary":"Creates an agent session and returns the session ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. This value is always 2.0"},"Id":{"type":"string","description":"The ID passed by the requester. The value is returned as is"},"Params":{"type":"string","description":"The business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_alert_rule","summary":"Creates a custom monitoring alert rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Owner","Enabled","TriggerCondition"],"properties":{"Name":{"type":"string","description":"The name of the custom rule"},"Owner":{"type":"string","description":"The Alibaba Cloud UID of the owner of the custom rule"},"Enabled":{"type":"string","description":"Specifies whether the alert rule is enabled"},"TriggerCondition":{"type":"string","description":"The condition that triggers the alert (JSON-encoded)"},"Notification":{"type":"string","description":"The alert notification configuration (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-business":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_business","summary":"Creates a business process in Data Studio for data development","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BusinessName"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier displayed in the workspace switcher at the top of the…"},"BusinessName":{"type":"string","description":"The name of the business process. The name must be unique within the same workspace"},"Description":{"type":"string","description":"The description of the business process"},"Owner":{"type":"string","description":"The Alibaba Cloud account ID of the owner of the business process. You can log on to the DataWorks console…"},"UseType":{"type":"string","enum":["NORMAL","MANUAL_BIZ"],"description":"The functional module to which the business process belongs. Valid values: NORMAL: Data Studio. MANUAL_BIZ: Manual business process"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-calendar":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_calendar","summary":"Creates a scheduling calendar","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Type","SchedulePolicy","Owner","Description"],"properties":{"Name":{"type":"string","description":"The name of the scheduling calendar. The name must be unique within the current tenant and can be up to 100 characters in length"},"AllProjects":{"type":"string","description":"Specifies whether the calendar applies to all workspaces. Default value: false. true: all workspaces. false: the workspaces specified by…"},"ProjectIds":{"type":"string","description":"The list of applicable workspace IDs. If AllProjects is set to false or left empty: This parameter is required and cannot be empty. If…"},"Type":{"type":"string","enum":["StrongConstraint","WeakConstraint"],"description":"The type of the calendar. StrongConstraint: strong constraint calendar. WeakConstraint: weak constraint calendar"},"StartDate":{"type":"string","description":"The start date of the calendar validity period. Format: `yyyy-mm-dd`. This parameter is required when Type is set to StrongConstraint"},"EndDate":{"type":"string","description":"The end date of the calendar validity period. Format: `yyyy-mm-dd`. This parameter is required when Type is set to StrongConstraint. The…"},"ExpirationReminder":{"type":"string","enum":["OneMonthBefore","OneWeekBefore","ThreeDaysBefore"],"description":"The expiration reminder. This parameter is required when Type is set to StrongConstraint. OneMonthBefore: one month in advance.…"},"OverduePolicy":{"type":"string","enum":["Normal","Pause","Skip"],"description":"The scheduling policy after the calendar expires. This parameter is required when Type is set to StrongConstraint. Normal: normal…"},"SchedulePolicy":{"type":"string","description":"The date scheduling policy. For a strong constraint calendar, the normal scheduling dates and non-scheduling dates must cover every day…"},"FallbackPolicy":{"type":"string","enum":["Normal","Pause","Skip"],"description":"The default scheduling policy for dates that are not configured. This parameter is required when Type is set to WeakConstraint. Normal:…"},"Owner":{"type":"string","description":"The account ID of the owner"},"Description":{"type":"string","description":"The description of the scheduling calendar. The description must be 5 to 2,048 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-component":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_component","summary":"Creates a component","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace where the data source resides. You can call the https://help.aliyun.com/document_detail/2780068.html…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the workflow. For more information about the specifications, see FlowSpec…"},"ClientToken":{"type":"string","description":"The reserved field"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-compute-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_compute_resource","summary":"Creates a compute resource in a specified workspace. The compute resource can be used in the development or…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Name","Type","ConnectionPropertiesMode","ConnectionProperties"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"Name":{"type":"string","description":"The name of the compute resource. The name can contain letters, digits, and underscores (_), and cannot start with a digit or an…"},"Type":{"type":"string","description":"The type of the compute resource. Multiple compute resource types are supported"},"ConnectionPropertiesMode":{"type":"string","enum":["UrlMode","InstanceMode","CdhMode"],"description":"The mode in which the compute resource is added. Different types have different subtypes and corresponding parameter constraints. For…"},"Description":{"type":"string","description":"The description of the compute resource. The description can be up to 3,000 characters in length"},"ConnectionProperties":{"type":"string","description":"The specific connection configuration information of the compute resource, including the endpoint, access identity, and environment…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-crawler":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_crawler","summary":"Creates a metadata crawler and configures the data source, collection scope, resource group, and scheduling…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","DataSourceId","Type"],"properties":{"Name":{"type":"string","description":"The name of the metadata crawler. The name can be up to 128 characters in length"},"DataSourceId":{"type":"integer","description":"The ID of the data source associated with the crawler. The data source must be bound to a DataWorks workspace, and the data source type…"},"Type":{"type":"string","description":"The crawler type. Call GetCrawlerTypeCapabilities to query the valid values supported in the current region"},"ResourceGroupId":{"type":"string","description":"The ID of the Serverless 2.0 resource group used to run the collection task. Whether this parameter is required depends on the…"},"Scope":{"type":"string","description":"The collection scope configuration. If this parameter is not specified, the DefaultScopeUnit value returned by GetCrawlerTypeCapabilities…"},"ScheduleConfig":{"type":"string","description":"The scheduling configuration. If this parameter is not specified, manual scheduling is used (JSON-encoded)"},"EnableAiComment":{"type":"string","description":"Specifies whether to enable AI metadata descriptions. This parameter is supported only when the SupportAiComment value returned by…"},"Options":{"type":"string","description":"The extended configuration for the crawler type. The key names, value types, required fields, default values, and valid values are…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-cross-project-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_cross_project_pipeline_run","summary":"Creates a cross-workspace deployment flow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","DeploymentEnvironmentId","Type","ObjectIds"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"DeploymentEnvironmentId":{"type":"integer","description":"The cross-workspace deployment environment ID"},"Type":{"type":"string","enum":["Online","Offline"],"description":"The deployment type. Valid values: Offline: Deployment to take the object offline. Online: Deployment to bring the object online"},"ObjectIds":{"type":"string","description":"The list of top-level object IDs from the source project to deploy. The list must contain exactly one object. Child objects of composite…"},"Description":{"type":"string","description":"The deployment description"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-custom-attribute":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_custom_attribute","summary":"Creates a custom attribute definition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","DisplayName","Type","EntityTypes"],"properties":{"Id":{"type":"string","description":"The custom attribute ID. The value must match `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. The part after custom-attribute: must be…"},"DisplayName":{"type":"string","description":"The display name of the custom attribute. The value must be less than 128 characters in length"},"Type":{"type":"string","enum":["ENUM","TEXT","HYPERLINK"],"description":"The type of the custom attribute. Valid values: ENUM, TEXT, and HYPERLINK"},"EntityTypes":{"type":"string","description":"The list of applicable entity types. Exact entity types and wildcard patterns such as `*-table` and `*-column` are supported. Examples:…"},"ValueEnums":{"type":"string","description":"The enumeration values. This parameter is required when type is set to ENUM. This parameter is not supported for TEXT or HYPERLINK types…"},"DisplayEnabled":{"type":"string","description":"Specifies whether to display the attribute on the details page. Default value: true"},"SearchFilterEnabled":{"type":"string","description":"Specifies whether the attribute can be used as a filter condition on the DataWorks Data Map search page. Default value: false. Currently,…"},"Comment":{"type":"string","description":"The description of the custom attribute. The value must be less than 256 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-dialarm-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_dialarm_rule","summary":"Creates an alert rule for a data integration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MetricType","DIJobId","Name","TriggerConditions","NotificationSettings"],"properties":{"Description":{"type":"string","description":"The description of the alert rule"},"MetricType":{"type":"string","description":"The alert metric type. Valid values: Heartbeat: task status alert. FailoverCount: failover count alert. Delay: task latency alert.…"},"Enabled":{"type":"string","description":"Specifies whether to enable the alert rule. By default, the alert rule is disabled"},"DIJobId":{"type":"integer","description":"The task ID associated with the alert rule"},"ClientToken":{"type":"string","description":"The idempotency parameter"},"Name":{"type":"string","description":"The name of the alert rule"},"TriggerConditions":{"type":"string","description":"The list of alert trigger conditions. Multiple conditions are supported (JSON-encoded)"},"NotificationSettings":{"type":"string","description":"The alert notification settings (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-dijob":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_dijob","summary":"Creates a task in the new version of Data Integration","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DestinationDataSourceType":{"type":"string","description":"The type of the destination data source. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub,…"},"Description":{"type":"string","description":"The description of the task"},"SourceDataSourceType":{"type":"string","description":"The type of the source data source. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive,…"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Name":{"type":"string","description":"The name of the task"},"MigrationType":{"type":"string","description":"The synchronization type. Valid values: FullAndRealtimeIncremental: full and real-time incremental synchronization for entire databases in…"},"JobType":{"type":"string","description":"The task type. Valid values: DatabaseRealtimeMigration: real-time migration of entire databases. Performs streaming synchronization of…"},"SourceDataSourceSettings":{"type":"string","description":"The list of source data source settings (JSON-encoded)"},"DestinationDataSourceSettings":{"type":"string","description":"The list of destination data source settings (JSON-encoded)"},"ResourceSettings":{"type":"string","description":"The resource settings (JSON-encoded)"},"TransformationRules":{"type":"string","description":"The list of synchronization object transformation rule definitions. [ { \"RuleName\":\"my_database_rename_rule\", \"RuleActionType\":\"Rename\",…"},"TableMappings":{"type":"string","description":"The list of synchronization object transformation mappings. Each element describes a group of source object selection rules and the…"},"JobSettings":{"type":"string","description":"The task-level settings, including DDL handling policies, source-to-destination column data type mapping policies, and task runtime…"},"JobName":{"type":"string","description":"[Deprecated] Use the Name parameter instead"},"Owner":{"type":"string","description":"The owner of the task"},"FileSpec":{"type":"string","description":"The code content in script mode"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-asset-tag":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_asset_tag","summary":"Creates a tag","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Key"],"properties":{"Key":{"type":"string","description":"The tag key"},"Values":{"type":"string","description":"The list of tag values (JSON-encoded)"},"Description":{"type":"string","description":"The tag description"},"ValueType":{"type":"string","enum":["Boolean","Int","String","Double"],"description":"The tag value type. Valid values: Boolean Int String Double"},"Managers":{"type":"string","description":"The list of tag administrators (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-quality-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_quality_alert_rule","summary":"Creates a data quality monitoring alert rule in a specified project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Condition","Target","Notification"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"Condition":{"type":"string","description":"The alert condition for the data quality monitoring alert rule"},"Target":{"type":"string","description":"The target of the data quality monitoring alert rule (JSON-encoded)"},"Notification":{"type":"string","description":"The list of alert channels (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-quality-scan":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_quality_scan","summary":"Creates a data quality monitor","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ClientToken"],"properties":{"Description":{"type":"string","description":"The description of the data quality monitor"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/overview) and go to the…"},"Owner":{"type":"string","description":"The ID of the user who owns of the data quality monitor"},"Spec":{"type":"string","description":"Spec code for the content of the data quality monitoring. For more information, see https://help.aliyun.com/document_detail/2963394.html"},"Parameters":{"type":"string","description":"The definition of execution parameters for the data quality monitoring (JSON-encoded)"},"RuntimeResource":{"type":"string","description":"The resource group used during execution of the data quality monitoring (JSON-encoded)"},"ComputeResource":{"type":"string","description":"The compute engine used at runtime. If not specified, the data source defined in the Spec is used (JSON-encoded)"},"Trigger":{"type":"string","description":"The trigger configurations of the data quality monitoring task (JSON-encoded)"},"Hooks":{"type":"string","description":"The Hook configurations after the data quality monitoring run ends (JSON-encoded)"},"Name":{"type":"string","description":"The data quality monitoring name"},"ClientToken":{"type":"string","description":"The idempotency token"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-quality-scan-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_quality_scan_run","summary":"Triggers the execution of a specified data quality monitoring task and returns the run instance ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DataQualityScanId":{"type":"integer","description":"The ID of the data quality monitoring task"},"ProjectId":{"type":"integer","description":"The project ID"},"Parameters":{"type":"string","description":"The parameter settings used during the actual run. The `triggerTime` parameter is required (JSON-encoded)"},"RuntimeResource":{"type":"string","description":"The schedule resource group used when the data quality monitoring task runs. This shares the same data structure as the scheduling API…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-quality-template":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_quality_template","summary":"Creates a data quality rule template in a specified project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"Spec":{"type":"string","description":"The Spec code for the detailed configuration of the rule template. For more information, see…"},"Owner":{"type":"string","description":"The ID of the owner"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-source":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_source","summary":"Creates a data source in a specified workspace for the development or production environment","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Name","Type","ConnectionPropertiesMode","ConnectionProperties"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/overview) and go to the…"},"Name":{"type":"string","description":"The name of the data source. The name can contain letters, digits, and underscores (_), and cannot start with a digit or an underscore.…"},"Type":{"type":"string","description":"The type of the data source. More than 70 data source types are supported. References: https://help.aliyun.com/document_detail/2852465.html"},"ConnectionPropertiesMode":{"type":"string","enum":["UrlMode","InstanceMode","CdhMode"],"description":"The category in which the data source is added. Different data source types have different subtypes and parameter constraints. For…"},"Description":{"type":"string","description":"The description of the data source. The description can be up to 3,000 characters in length"},"ConnectionProperties":{"type":"string","description":"The specific connection configuration of the data source, including the endpoint, access identity, and environment context. The envType…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-data-source-shared-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_data_source_shared_rule","summary":"Creates a sharing rule for a data source to share it with other workspaces or RAM users","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DataSourceId","TargetProjectId","EnvType"],"properties":{"DataSourceId":{"type":"integer","description":"The data source ID"},"TargetProjectId":{"type":"integer","description":"The ID of the workspace to which you want to share the data source. You cannot share the data source to the workspace with which the data…"},"SharedUser":{"type":"string","description":"The user with which you want to share the data source. If you do not configure this parameter, the data source is shared to an entire…"},"EnvType":{"type":"string","description":"The environment of the target workspace to which the data source is shared. Valid values: Dev: development environment Prod: production…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-dataset":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_dataset","summary":"Creates a dataset. You can create a dataset only in a workspace that you have joined. Only DataWorks…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Name","StorageType","InitVersion"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace"},"Origin":{"type":"string","description":"The origin of the dataset. Only DataWorks is supported"},"Name":{"type":"string","description":"The name of the dataset. The value must be a non-empty string that is up to 128 characters in length"},"Comment":{"type":"string","description":"The description of the dataset. The value can be up to 1024 characters in length"},"DataType":{"type":"string","description":"The data type. Valid values: COMMON: general-purpose (default). PIC: image. TEXT: text. TABLE: table. VIDEO: video. AUDIO: audio. INDEX:…"},"StorageType":{"type":"string","description":"The storage type. Valid values: OSS: Object Storage Service. NAS: general-purpose NAS file storage. EXTREMENAS: extreme NAS file storage.…"},"InitVersion":{"type":"string","description":"The initial version of the dataset (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-dataset-version":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_dataset_version","summary":"Creates a dataset version. Currently, only DataWorks datasets are supported. The maximum number of versions…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DatasetId","Url"],"properties":{"DatasetId":{"type":"string","description":"The dataset ID. Currently, only DataWorks datasets are supported"},"Comment":{"type":"string","description":"The description of the dataset version. The description can be up to 1024 characters in length"},"Url":{"type":"string","description":"The URL"},"MountPath":{"type":"string","description":"The mount path. The path must start with /mnt/. Default value: /mnt/data"},"ImportInfo":{"type":"string","description":"The storage import configuration for the dataset. The required configuration varies depending on the storage type. NAS The values can be…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_file","summary":"Creates a file in Data Studio. This operation does not support creating data integration node tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileName","FileType"],"properties":{"FileFolderPath":{"type":"string","description":"The file path"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"FileName":{"type":"string","description":"The name of the file"},"FileDescription":{"type":"string","description":"The description of the file"},"FileType":{"type":"integer","description":"The code type of the file. Different file types have different code formats. For more information, see…"},"Owner":{"type":"string","description":"The Alibaba Cloud user ID of the file owner. If this parameter is left empty, the Alibaba Cloud user ID of the caller is used by default"},"Content":{"type":"string","description":"The code content of the file. The code format varies based on the code type (fileType) of the file. You can find a task of the…"},"AutoRerunTimes":{"type":"integer","description":"The maximum number of automatic reruns after an error occurs. Maximum value: 10"},"AutoRerunIntervalMillis":{"type":"integer","description":"The interval between automatic reruns after a failure, in milliseconds. Maximum value: 1800000 (30 minutes). This parameter corresponds to…"},"RerunMode":{"type":"string","enum":["ALL_ALLOWED","FAILURE_ALLOWED","ALL_DENIED"],"description":"The rerun policy. Valid values: ALL_ALLOWED: The task can be rerun after it succeeds or fails. FAILURE_ALLOWED: The task cannot be rerun…"},"Stop":{"type":"string","description":"Specifies whether to pause scheduling. Valid values: true: Pauses scheduling. false: Does not pause scheduling. This parameter corresponds…"},"ParaValue":{"type":"string","description":"The scheduling parameters. Separate multiple parameters with spaces. This parameter corresponds to the Schedule Settings > Scheduling…"},"StartEffectDate":{"type":"integer","description":"The timestamp in milliseconds when automatic scheduling starts. This parameter corresponds to the start time in milliseconds configured in…"},"EndEffectDate":{"type":"integer","description":"The timestamp in milliseconds when automatic scheduling stops. This parameter corresponds to the end time in milliseconds configured in…"},"CronExpress":{"type":"string","description":"The cron expression for periodic scheduling. This parameter corresponds to the Schedule Settings > Time Property > Cron Expression setting…"},"CycleType":{"type":"string","enum":["DAY","NOT_DAY"],"description":"The type of the scheduling cycle. Valid values: NOT_DAY (minutes and hours) and DAY (days, weeks, and months). This parameter corresponds…"},"DependentType":{"type":"string","enum":["NONE","USER_DEFINE","CHILD","SELF","USER_DEFINE_AND_SELF","CHILD_AND_SELF"],"description":"The dependency on the previous cycle. Valid values: SELF: Depends on the current node. CHILD: Depends on the first-level child nodes.…"},"DependentNodeIdList":{"type":"string","description":"The IDs of the nodes on which the current file depends when the DependentType parameter settings are USER_DEFINE. Separate multiple node…"},"InputList":{"type":"string","description":"The output names of the upstream files on which the current file depends. Separate multiple output names with commas (,). This parameter…"},"OutputList":{"type":"string","description":"The output of the file. This parameter corresponds to the Output Name of Current Node setting in Schedule Settings > Scheduling…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"ResourceGroupIdentifier":{"type":"string","description":"The resource group used to run the task after the file is published as a task. You can log on to the DataWorks console…"},"ResourceGroupId":{"type":"integer","description":"[Deprecated] Do not use this field"},"ConnectionName":{"type":"string","description":"The data source connected when the task is run after the file is published as a task. You can call the…"},"AutoParsing":{"type":"string","description":"Specifies whether to enable automatic parsing for the file. Valid values: true: Automatically parses the code in the file. false: Does not…"},"SchedulerType":{"type":"string","enum":["NORMAL","MANUAL","PAUSE","SKIP"],"description":"The scheduling type. Valid values: NORMAL: Normal scheduling task. MANUAL: Manual task. It is not run on a daily schedule and corresponds…"},"AdvancedSettings":{"type":"string","description":"The advanced settings of the task. This parameter corresponds to the Advanced Settings in the right-side navigation pane of the edit page…"},"StartImmediately":{"type":"string","description":"Specifies whether to start the task immediately after it is published. This parameter corresponds to the Configuration > Time Attributes >…"},"InputParameters":{"type":"string","description":"The context input parameters of the node. The parameter value is in JSON format. For the included fields, refer to the structure of the…"},"OutputParameters":{"type":"string","description":"The context output parameters of the node. The parameter value is in JSON format. For the included fields, refer to the structure of the…"},"IgnoreParentSkipRunningProperty":{"type":"string","description":"Specifies whether to inherit the dry-run property from the previous cycle. Valid values: true: Inherits the dry-run property from the…"},"CreateFolderIfNotExists":{"type":"string","description":"Specifies whether to automatically create the directory specified by the FileFolderPath parameter if the directory does not exist. Valid…"},"ApplyScheduleImmediately":{"type":"string","description":"Specifies whether the scheduling configuration takes effect immediately after the file is published"},"Timeout":{"type":"integer","description":"The timeout definition in the scheduling configuration"},"ImageId":{"type":"string","description":"The ID of the custom image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-folder":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_folder","summary":"Creates a folder","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FolderPath"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console.…"},"FolderPath":{"type":"string","description":"The path of the folder"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-function":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_function","summary":"Creates a UDF function in Data Studio. The UDF function information is described in FlowSpec format","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the UDF function. For more information about the specifications, see FlowSpec…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-identify-credential":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_identify_credential","summary":"Creates an identity credential","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"IdentifyCredential":{"type":"string","description":"The user identity credential object (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_image","summary":"Creates an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","ProviderType","Namespace","RepositoryName","Supported","ClientToken"],"properties":{"Name":{"type":"string","description":"The name of the image. The name can contain lowercase letters, digits, and underscores (_), and can be up to 128 characters in length"},"Description":{"type":"string","description":"The description of the image. The description can be up to 128 characters in length"},"Accessibility":{"type":"string","enum":["Public","Private"],"description":"The visibility of the image. Valid values: Public: The image is visible to all users. Private: The image is visible only to the creator"},"ProviderType":{"type":"string","enum":["ACR","DataWorks"],"description":"The reference data type of the image. Valid values: ACR: ACR image repository. DataWorks: DataWorks official image"},"Namespace":{"type":"string","description":"The namespace of the image. If you reference a DataWorks official image, set this parameter to DataWorks Default"},"RepositoryName":{"type":"string","description":"The name of the image repository. If you reference a DataWorks official image, set this parameter to DataWorks Default"},"ProviderImageId":{"type":"string","description":"The ID of the image provided by the image provider. This parameter is required if you reference a DataWorks official image"},"AcrInstanceId":{"type":"string","description":"The ACR instance ID. This parameter is required if you reference an ACR image"},"ImageUri":{"type":"string","description":"The URI of the image. This parameter is required if you reference an ACR image"},"AcrAssociatedVpcId":{"type":"string","description":"The ID of the virtual private cloud (VPC) associated with the ACR instance. This parameter is required if you reference an ACR image"},"EnableSyncMaxCompute":{"type":"string","description":"Specifies whether to synchronize the image to MaxCompute. Specify this parameter when you reference an ACR image. Default value: false"},"Supported":{"type":"string","description":"The sub-purpose of the image (JSON-encoded)"},"BuildConfig":{"type":"string","description":"The build configuration of the image (JSON-encoded)"},"ClientToken":{"type":"string","description":"The client token that is used to ensure idempotence"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-lineage-relationship":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_lineage_relationship","summary":"Registers a data lineage relationship in DataWorks Data Map. You can use this operation to establish lineage…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SrcEntity":{"type":"string","description":"The source entity (JSON-encoded)"},"DstEntity":{"type":"string","description":"The destination entity (JSON-encoded)"},"Task":{"type":"string","description":"The task information (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-mcp-server":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_mcp_server","summary":"Creates an MCP server","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the MCP server. It must be unique at the tenant level. It must start with a lowercase letter and can contain only lowercase…"},"Config":{"type":"string","description":"The connection configuration of the MCP server (JSON-encoded)"},"Visibility":{"type":"string","enum":["TENANT","PROJECT","USER"],"description":"The visibility level"},"VisibilityScope":{"type":"string","description":"The visibility scope. Specify the corresponding fields based on the value of Visibility (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_meta_collection","summary":"Creates a collection in Data Map. Collections include categories, subcategories, data albums, and categories…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Type"],"properties":{"ParentId":{"type":"string","description":"The parent collection ID"},"Name":{"type":"string","description":"The name of the collection"},"Type":{"type":"string","enum":["Category","Album","AlbumCategory"],"description":"The collection type. Valid values: Category: category. Album: data album. AlbumCategory: album subcategory"},"Description":{"type":"string","description":"The collection description"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-meta-entity-def":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_meta_entity_def","summary":"Creates a metadata entity definition, including custom types and extended table types","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","DisplayName"],"properties":{"Name":{"type":"string","description":"The name of the type definition. Custom types must match `^[a-z0-9][a-z0-9_]*$`. Extended table types must match…"},"DisplayName":{"type":"string","description":"The display name, up to 32 characters"},"Description":{"type":"string","description":"The description"},"Extend":{"type":"string","enum":["NONE","TABLE"],"description":"The extension mode. Valid values: NONE: default value. Indicates a custom entity with freely defined attributes. TABLE: indicates an…"},"AttributeDefs":{"type":"string","description":"The attribute definition list for custom entities. This parameter cannot be specified when extend is set to TABLE (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-network":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_network","summary":"Creates a network and associates the network with a general resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId","VpcId","VswitchId","ClientToken"],"properties":{"ResourceGroupId":{"type":"string","description":"The ID of the serverless resource group"},"VpcId":{"type":"string","description":"The ID of the virtual private cloud (VPC)"},"VswitchId":{"type":"string","description":"The VSwitch ID"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-node":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_node","summary":"Creates a Data Studio node in the new version of Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Scene","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"ContainerId":{"type":"string","description":"The unique identifier of a container in which you want to create the node. The container can be a workflow or a container node. Specify…"},"Scene":{"type":"string","description":"The scenario in which the node is created. This parameter determines whether the node is created in the manual node area or the Data…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the node. For more information about the specification, see FlowSpec…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-parameter":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_parameter","summary":"Creates a parameter","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Properties","Type","ProjectId","Owner"],"properties":{"Name":{"type":"string","description":"The name of the parameter. It must be unique within the workspace. It must start with \"workspace.\". The subsequent content must start with…"},"Properties":{"type":"string","description":"The parameter value configurations. This parameter is required for the production environment. If duplicate environment configurations…"},"Type":{"type":"string","enum":["PlainConstant","SecretConstant","Variable"],"description":"The type. Valid values: PlainConstant: plaintext constant. SecretConstant: ciphertext constant. Variable: variable"},"ProjectId":{"type":"integer","description":"The workspace ID. This parameter is required when Scope is set to Project"},"Owner":{"type":"string","description":"The account ID of the owner"},"Description":{"type":"string","description":"The description"},"Scope":{"type":"string","enum":["Project"],"description":"The scope of the parameter. Default value: Project. Other types are currently not supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_pipeline_run","summary":"Creates a deployment process for an entity in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Type","ObjectIds"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Type":{"type":"string","description":"Specifies the type of the deployment process. Valid values: Online: Goes online. Offline: Goes offline"},"ObjectIds":{"type":"string","description":"The list of entity IDs to be deployed in this deployment process. Currently, only a single entity and its child entities can be deployed.…"},"Description":{"type":"string","description":"The description of the deployment process"},"RunMode":{"type":"string","enum":["Normal","Auto"],"description":"The running mode of the deployment process. Default value: Normal. If you set this parameter to Auto, the deployment process automatically…"},"AutoRunUntilStage":{"type":"string","description":"The code of the stage to which the deployment process runs. This parameter takes effect only when the RunMode parameter is set to Auto.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-process-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_process_definition","summary":"Creates a new approval process definition, supporting custom configuration of approval rules and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","Description","RuleConditions","ApprovalNodes"],"properties":{"Name":{"type":"string","description":"The name of the process definition"},"Description":{"type":"string","description":"The description of the process definition"},"Type":{"type":"string","description":"The type of the process definition. Valid values: MaxCompute DataService Extension Hologres"},"SubType":{"type":"string","description":"The subtype. Valid values: Table Column Database Schema Default"},"Enabled":{"type":"string","description":"Specifies whether to enable the process definition"},"RuleConditions":{"type":"string","description":"The list of condition rules (JSON-encoded)"},"NotificationServices":{"type":"string","description":"The notification service declarations (JSON-encoded)"},"ApprovalNodes":{"type":"string","description":"The list of approval nodes (JSON-encoded)"},"ClientToken":{"type":"string","description":"The idempotency token. We recommend that you use a UUID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-project":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_project","summary":"Creates a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","DisplayName"],"properties":{"Name":{"type":"string","description":"The workspace name. Constraints: The workspace name must be unique within the region. The name must start with a letter and can contain…"},"DisplayName":{"type":"string","description":"The display name of the workspace"},"Description":{"type":"string","description":"The description of the workspace"},"AliyunResourceGroupId":{"type":"string","description":"The ID of the Alibaba Cloud resource group to which the workspace belongs. You can log on to the Resource Management console…"},"PaiTaskEnabled":{"type":"string","description":"Specifies whether to enable PAI task scheduling. Valid values: true: You can create Machine Learning Platform for AI (PAI) nodes in the…"},"DevEnvironmentEnabled":{"type":"string","description":"Specifies whether to enable the development environment. Valid values: true: The development environment is enabled for the workspace,…"},"AliyunResourceTags":{"type":"string","description":"The list of tags (JSON-encoded)"},"DevRoleDisabled":{"type":"string","description":"Specifies whether to disable the development role. Valid values: false: The development role is enabled. This is the default value. true:…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-project-member":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_project_member","summary":"Adds a workspace member and grants workspace roles to the member","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","UserId","RoleCodes"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"UserId":{"type":"string","description":"The ID of the DataWorks account. You can log on to the DataWorks console - Management Center…"},"RoleCodes":{"type":"string","description":"The list of workspace role codes. You can call https://help.aliyun.com/document_detail/2853930.html to obtain the role codes. This…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-project-role":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_project_role","summary":"Creates a custom role for a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Name"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to…"},"Name":{"type":"string","description":"The role name"},"ModulePermissions":{"type":"string","description":"The list of DataWorks module permissions (JSON-encoded)"},"ClientToken":{"type":"string","description":"The client token"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_resource","summary":"Creates a file resource for Data Studio. The file resource information is defined in FlowSpec format","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the resource file. For more information about the specification, see FlowSpec…"},"ResourceFile":{"type":"string","description":"The file stream or Object Storage Service (OSS) download URL of the resource file. This field allows you to specify a file stream or an…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-resource-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_resource_file","summary":"Supports users in specifying their own files (such as JAR, PY, archive, or file) to create Data Studio…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","FileFolderPath","FileName","FileType","OriginResourceName","RegisterToCalcEngine"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console, go to the workspace configuration page, and obtain the…"},"FileFolderPath":{"type":"string","description":"The path of the file"},"FileName":{"type":"string","description":"The name of the file"},"FileType":{"type":"integer","description":"The code type of the file. Different file types correspond to different code types. For more information, see…"},"FileDescription":{"type":"string","description":"The description of the file"},"Owner":{"type":"string","description":"The Alibaba Cloud User ID of the file owner. If this parameter is empty, the Alibaba Cloud User ID of the caller is used by default"},"Content":{"type":"string","description":"The code content of the file. The code format varies depending on the code type (fileType). You can locate a job of the corresponding type…"},"ResourceFile":{"type":"string","description":"The OSS URL for file upload provided by POP"},"OriginResourceName":{"type":"string","description":"The name of the original resource file"},"UploadMode":{"type":"string","description":"The upload mode for the resource file. This parameter currently applies only to File-type files in MaxCompute. Valid values: true:…"},"RegisterToCalcEngine":{"type":"string","description":"Indicates whether to synchronize and upload the resource to the compute engine"},"StorageURL":{"type":"string","description":"The Storage Path of the resource file on the compute engine. This field is currently used only by EMR and CDH. The EMR format is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-resource-group":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_resource_group","summary":"Creates a resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","PaymentType","VpcId","VswitchId","ClientToken"],"properties":{"Name":{"type":"string","description":"The name of the general-purpose resource group. It must start with a letter and can contain letters, digits, and underscores (_). It can…"},"Remark":{"type":"string","description":"The remark of the general-purpose resource group. It can contain letters, Chinese characters, digits, and underscores (_). It can be up to…"},"PaymentType":{"type":"string","enum":["PrePaid","PostPaid"],"description":"The billing method of the resource group. PrePaid indicates subscription, and PostPaid indicates pay-as-you-go"},"PaymentDurationUnit":{"type":"string","enum":["Month","Year"],"description":"The unit of the billing duration. Month indicates months, and Year indicates years"},"PaymentDuration":{"type":"integer","description":"The billing duration"},"AutoRenewEnabled":{"type":"string","description":"Specifies whether to enable auto-renewal"},"Spec":{"type":"integer","description":"The specifications of the resource group. Unit: CU. This parameter is required when the billing method of the resource group is PrePaid"},"VpcId":{"type":"string","description":"The ID of the default VPC"},"VswitchId":{"type":"string","description":"The ID of the default vSwitch"},"ClientToken":{"type":"string","description":"The client token that is used to ensure the idempotence of the request"},"AliyunResourceGroupId":{"type":"string","description":"The ID of the Alibaba Cloud resource group"},"AliyunResourceTags":{"type":"string","description":"The list of Alibaba Cloud tags (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-route":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_route","summary":"Creates a route for a network","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["NetworkId","DestinationCidr"],"properties":{"NetworkId":{"type":"integer","description":"The network ID"},"DestinationCidr":{"type":"string","description":"The CIDR blocks of the destination-based route"},"ResourceGroupId":{"type":"string","description":"Unique identifier of the serverless resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-security-strategy":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_security_strategy","summary":"Creates a new security control policy and supports the configuration of multiple modules and submodules.…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","SchemaName","ControlModule","ControlDwScope","Content"],"properties":{"Name":{"type":"string","description":"The policy name"},"Description":{"type":"string","description":"The description of the policy"},"SchemaName":{"type":"string","enum":["DataQuerySecurityStrategySchema","DataStudioSecurityStrategySchema","DataStudioMyCatalogSecurityStrategySchema"],"description":"The name of the schema template"},"ControlModule":{"type":"string","enum":["DataQuery","DataStudio"],"description":"The control module"},"ControlSubModule":{"type":"string","enum":["MyCatalog"],"description":"The control submodule"},"ControlDwScope":{"type":"string","enum":["Tenant","Workspace"],"description":"The control scope"},"Workspaces":{"type":"string","description":"The list of associated workspace IDs (JSON-encoded)"},"Content":{"type":"string","description":"The policy content. The content is constrained by SecurityStrategySchema (JSON-encoded)"},"ClientToken":{"type":"string","description":"The idempotency parameter. This parameter is used to prevent duplicate operations caused by multiple calls"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-semantic-job":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_semantic_job","summary":"Saves a reusable semantic job definition. If you use a single-file source, apply for and complete the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","ResourceGroupId","Source"],"properties":{"Name":{"type":"string","description":"The semantic job name, which also serves as the job identifier for subsequent calls to RunSemanticJob, DeleteSemanticJob,…"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. This parameter is required for all Source.type values except singleTableFile. The Data.ProjectId in the…"},"ResourceGroupId":{"type":"string","description":"The ID of the resource group used to run the semantic job. RunSemanticJob does not accept this parameter and instead uses the resource…"},"Source":{"type":"string","description":"The input datasource config for the semantic node. The type field is required. This parameter specifies the data to be analyzed and is not…"},"ReferenceFileIds":{"type":"string","description":"The list of uploaded reference file IDs. When Source.type=singleTableFile, use either this parameter or ReferenceFileUris, and the…"},"ReferenceFileUris":{"type":"string","description":"The list of reference file URIs accessible by the caller. When Source.type=singleTableFile, use either this parameter or ReferenceFileIds,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-server-ide-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_server_ide_instance","summary":"Creates a personal development environment instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","ResourceGroupId","InstanceName"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"ResourceGroupId":{"type":"string","description":"The DataWorks resource group identifier. You can specify the numeric ID of the resource group or the full identifier in the…"},"Cu":{"type":"integer","description":"The number of CUs used by the instance"},"Owner":{"type":"string","description":"The Alibaba Cloud account ID of the user who owns the instance. If this parameter is not specified, the current caller is used by default"},"ImageId":{"type":"string","description":"The image ID. You can call ListServerIdeImages to obtain the image ID"},"ImageUrl":{"type":"string","description":"The image URL. This parameter is required when you use a non-official DataWorks image"},"InstanceName":{"type":"string","description":"The name of the personal development environment instance"},"UserVpc":{"type":"string","description":"The Virtual Private Cloud (VPC) configuration used by the instance (JSON-encoded)"},"Datasets":{"type":"string","description":"The list of datasets mounted to the instance (JSON-encoded)"},"CredentialConfig":{"type":"string","description":"The credential injection configuration for the instance. After this feature is enabled, you can use the default RAM role chain or specify…"},"UserCommand":{"type":"string","description":"The user command configuration to be executed when the instance starts (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-skill":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_skill","summary":"Creates a skill in DataWorks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The skill name. The name must be unique within the current account"},"Description":{"type":"string","description":"The skill description"},"Visibility":{"type":"string","enum":["TENANT","PROJECT","USER"],"description":"The visibility level. Valid values: TENANT (visible to the entire tenant), PROJECT (visible to specific projects), and USER (visible to…"},"VersionNote":{"type":"string","description":"The version note"},"SkillMdOverride":{"type":"string","description":"The content of the SKILL.md file. This parameter and BundleUrl are mutually exclusive. If you do not provide a bundle, use this parameter…"},"BundleUrl":{"type":"string","description":"The download URL of the bundle.zip file (HTTP or HTTPS). This parameter and SkillMdOverride are mutually exclusive"},"Extra":{"type":"string","description":"The extended metadata in key-value pairs (JSON-encoded)"},"VisibilityScope":{"type":"string","description":"The visibility scope. Specify the corresponding field based on the value of Visibility (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-udf-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_udf_file","summary":"Creates a file for a function in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileFolderPath","FileName","FunctionType","ClassName","Resources"],"properties":{"FileFolderPath":{"type":"string","description":"The path to the folder containing the function file"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page"},"FileName":{"type":"string","description":"The function name"},"FunctionType":{"type":"string","enum":["MATH","AGGREGATE","STRING","DATE","ANALYTIC","OTHER"],"description":"The function category, corresponding to the function type field in the Create Function form. Valid values: MATH (mathematical functions),…"},"ClassName":{"type":"string","description":"The class name where the function is defined, corresponding to the class name field in the Create Function form"},"Resources":{"type":"string","description":"A comma-separated list of resource names referenced by the function, corresponding to the resource list field in the Create Function form"},"UdfDescription":{"type":"string","description":"The function purpose description, corresponding to the description field in the Create Function form"},"CmdDescription":{"type":"string","description":"The command format for invoking the function, corresponding to the command format field in the Create Function form"},"ParameterDescription":{"type":"string","description":"The function parameter description, corresponding to the parameter description field in the Create Function form"},"ReturnValue":{"type":"string","description":"The return value description, corresponding to the return value field in the Create Function form"},"Example":{"type":"string","description":"An example demonstrating how to call the function, corresponding to the example field in the Create Function form"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier at the top of the Data Studio page where you switch…"},"CreateFolderIfNotExists":{"type":"string","description":"Specifies whether to automatically create the directory if the specified path (FileFolderPath) does not exist. Valid values: true:…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_workflow_definition","summary":"Creates a workflow in a specified directory in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the workflow. For more information about the specifications, see FlowSpec…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/create-workflow-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_create_workflow_instances","summary":"Creates a workflow instance based on configurations, such as a data backfill workflow instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","WorkflowId","Name","Type"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production Dev: development"},"WorkflowId":{"type":"integer","description":"The ID of the workflow. The WorkflowId of a scheduled task is always 1"},"Name":{"type":"string","description":"The name"},"Periods":{"type":"string","description":"The data backfill period settings (JSON-encoded)"},"Type":{"type":"string","enum":["ManualWorkflow","SupplementData","Manual","SmokeTest","TriggerWorkflow"],"description":"The type of the workflow instance. Valid values: SupplementData: data backfill. The methods for specifying RootTaskIds and IncludeTaskIds…"},"WorkflowParameters":{"type":"string","description":"The workflow parameters. This parameter takes effect only when a specific workflow is specified (WorkflowId != 1). For a periodic workflow…"},"TaskParameters":{"type":"string","description":"The task parameters, which are used to set parameters for specific tasks. The value is in JSON format. The key is the task ID, and the…"},"AutoStartEnabled":{"type":"string","description":"Specifies whether to run the workflow instance immediately after it is created. Default value: true"},"DefaultRunProperties":{"type":"string","description":"The runtime configurations (JSON-encoded)"},"Comment":{"type":"string","description":"The reason for creation"},"Tags":{"type":"string","description":"The list of task tags (JSON-encoded)"},"TagCreationPolicy":{"type":"string","enum":["Append","Overwrite"],"description":"The tag creation policy. Valid values: Append: Append mode. Inherits existing tags from the manual workflow and appends new tags.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-agent":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_agent","summary":"Deletes an Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the Agent to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_alert_rule","summary":"Deletes a custom monitoring alert rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the custom rule"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-business":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_business","summary":"Deletes a workflow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BusinessId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to query the…"},"BusinessId":{"type":"integer","description":"The workflow ID. You can call the https://help.aliyun.com/document_detail/173945.html operation to query the ID of a workflow by name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-calendar":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_calendar","summary":"Deletes a scheduling calendar","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the scheduling calendar"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-certificate":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_certificate","summary":"Deletes a certificate file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId"],"properties":{"Id":{"type":"integer","description":"The ID of the certificate file, which is the unique identifier of the certificate file"},"ProjectId":{"type":"integer","description":"The ID of the project to which the certificate file to be deleted belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-component":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_component","summary":"Deletes a component","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","ComponentId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"ComponentId":{"type":"string","description":"The ID of the component. You can use this ID as a request parameter to query the component list or modify a component"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-compute-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_compute_resource","summary":"Deletes the specified computing resource based on the computing resource ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId"],"properties":{"Id":{"type":"integer","description":"The computing resource ID, the unique identifier of the data source"},"ProjectId":{"type":"integer","description":"The workspace ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-crawler":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_crawler","summary":"Deletes a specified metadata crawler","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the metadata crawler. You can call ListCrawlers to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-custom-attribute":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_custom_attribute","summary":"Deletes a custom attribute definition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the custom attribute"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-dialarm-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_dialarm_rule","summary":"Deletes an alert rule configured for a synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The alert rule ID"},"DIJobId":{"type":"integer","description":"The ID of the synchronization task"},"DIAlarmRuleId":{"type":"integer","description":"This parameter is deprecated. Use the Id parameter instead"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-dijob":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_dijob","summary":"Deletes a new-version synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the synchronization task"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"DIJobId":{"type":"integer","description":"This parameter is deprecated. Use the Id parameter instead"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-asset-tag":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_asset_tag","summary":"Deletes a tag","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Key"],"properties":{"Key":{"type":"string","description":"The tag key"},"Values":{"type":"string","description":"The tag values (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-quality-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_quality_alert_rule","summary":"Deletes a data quality monitoring alert rule based on the specified ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the data quality rule template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-quality-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_quality_rule","summary":"Deletes a data quality monitoring rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The rule ID"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-quality-scan":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_quality_scan","summary":"Deletes a data quality monitor","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"The deprecated parameter. No configuration is required"},"Id":{"type":"integer","description":"The ID of the data quality monitor"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-quality-template":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_quality_template","summary":"Deletes a data quality rule template by ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"The ID of the custom rule template"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-source":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_source","summary":"Deletes a data source by data source ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The data source ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-data-source-shared-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_data_source_shared_rule","summary":"Deletes a data source sharing rule by its ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the data source sharing rule. You can call the ListDataSourceSharedRules operation to query existing sharing rules and their IDs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-dataset":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_dataset","summary":"Deletes a dataset. Only DataWorks datasets are supported. The corresponding dataset versions are cascade…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset ID. Only DataWorks datasets are supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-dataset-version":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_dataset_version","summary":"Deletes a dataset version. Only non-v1 DataWorks dataset versions can be deleted by using this operation. To…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset version ID. Only DataWorks datasets are supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_file","summary":"Deletes a file from Data Studio. If the file has been committed, an asynchronous process is triggered to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"FileId":{"type":"integer","description":"The file ID. You can call the https://help.aliyun.com/document_detail/173942.html operation to obtain the file ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-folder":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_folder","summary":"Invoke DeleteFolder to delete a folder on the Data Studio page","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FolderId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to query the…"},"FolderId":{"type":"string","description":"The folder ID. You can call the https://help.aliyun.com/document_detail/173955.html operation to obtain the folder ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-function":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_function","summary":"Deletes a user-defined function (UDF) in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the UDF. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_image","summary":"Deletes an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-lineage-relationship":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_lineage_relationship","summary":"Deletes a specified data lineage relationship from DataWorks Data Map","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the lineage relationship. You can obtain this ID from the response of the ListLineageRelationships operation. The ID is in the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-mcp-server":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_mcp_server","summary":"Delete MCP Server","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the MCP Server to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_meta_collection","summary":"Delete a collection object in the specified Data Map, including Data Map categories and data albums. When…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The collection ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-meta-entity-def":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_meta_entity_def","summary":"Deletes a metadata entity definition, including custom entity types and extension table types","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EntityType"],"properties":{"EntityType":{"type":"string","description":"The entity type"},"Force":{"type":"string","description":"Specifies whether to force delete the entity definition. Default value: false. Valid values: true: Automatically deletes all entity…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-network":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_network","summary":"Disassociates and deletes a network resource from a general-purpose resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the network resource to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-node":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_node","summary":"Deletes a specified Data Studio node","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio node. <notice>This field was of the Long type in SDK versions earlier than 8.0.0 and is of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-parameter":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_parameter","summary":"Deletes a specified parameter","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the parameter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-process-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_process_definition","summary":"Deletes a process definition by the specified ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the process definition to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-project":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_project","summary":"Deletes a DataWorks workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-project-member":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_project_member","summary":"Removes a workspace member and the workspace roles granted to the member","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","UserId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"UserId":{"type":"string","description":"The ID of the DataWorks account. You can log on to the DataWorks console - Management Center…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-project-role":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_project_role","summary":"Deletes a custom role from a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Code"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to…"},"Code":{"type":"string","description":"The unique identifier of the custom role"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_resource","summary":"Deletes a file resource from Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the resource file. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-resource-group":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_resource_group","summary":"Deletes a general-purpose resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The unique identifier of the resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-route":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_route","summary":"Deletes a route from a network resource","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The route ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-security-strategy":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_security_strategy","summary":"Deletes a security strategy by its ID. To call this operation, you must have DataWorks tenant administrator…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the security strategy"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-semantic-job":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_semantic_job","summary":"Deletes a semantic job definition by the Name of a created job. If the job is currently running, call…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the job to delete. Use the Data.Name value from the CreateSemanticJob response or the Name value from a ListSemanticJobs list…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-server-ide-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_server_ide_instance","summary":"Deletes a specified personal development environment instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the personal development environment instance. You can call ListServerIdeInstances to obtain the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-skill":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_skill","summary":"Delete Skill","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the Skill to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-task":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_task","summary":"Deletes a specified task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The task ID"},"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The project environment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-workflow":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_workflow","summary":"Deletes a specified workflow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The unique identifier of the workflow"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production Dev: development"},"ClientUniqueCode":{"type":"string","description":"The client unique code of the workflow, which is used to implement asynchronous operations and idempotence. If you do not specify this…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/delete-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_delete_workflow_definition","summary":"Deletes a specified workflow in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio workflow. <notice>This field was of the Long type in SDK versions earlier than 8.0.0 and is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/deploy-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_deploy_file","summary":"Deploys a file to the production environment","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the…"},"FileId":{"type":"integer","description":"The ID of the file. You can call https://help.aliyun.com/document_detail/173942.html to query the file ID. You need to specify only one of…"},"Comment":{"type":"string","description":"The description of the deployment"},"NodeId":{"type":"integer","description":"The ID of the node in the scheduling system that corresponds to the file to be published. You need to specify only one of this parameter…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/disable-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_disable_image","summary":"Disables an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/disable-process-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_disable_process_definition","summary":"Disables the specified approval process definition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"The process definition ID"},"ClientToken":{"type":"string","description":"An idempotence token used to make the request idempotent. A universally unique identifier (UUID) is recommended"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/dissociate-project-from-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_dissociate_project_from_image","summary":"Disassociates an image from a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId"],"properties":{"Id":{"type":"string","description":"The ID of the image"},"ProjectId":{"type":"integer","description":"The ID of the workspace"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/dissociate-project-from-resource-group":{"post":{"operationId":"cloud_aliyun_dataworks_public_dissociate_project_from_resource_group","summary":"Disassociates a resource group from a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId","ProjectId"],"properties":{"ResourceGroupId":{"type":"string","description":"The unique identifier of the resource group"},"ProjectId":{"type":"integer","description":"The ID of the workspace to disassociate"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/download-semantic-results":{"post":{"operationId":"cloud_aliyun_dataworks_public_download_semantic_results","summary":"Returns the download URL of artifacts by job name and an optional run ID after a run completes. If JobRunId…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobName"],"properties":{"JobName":{"type":"string","description":"The job name. You can obtain this value from Data.Name in the CreateSemanticJob response, Name in the ListSemanticJobs response, or…"},"JobRunId":{"type":"string","description":"The optional run ID. If you specify the JobRunId from the RunSemanticJob response (Data.JobRunId) or the ListSemanticJobRuns response,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/enable-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_enable_image","summary":"Enables an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/enable-process-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_enable_process_definition","summary":"Enables a process definition with the specified ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"process definition ID"},"ClientToken":{"type":"string","description":"The idempotence token. A UUID is recommended"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/establish-relation-table-to-business":{"post":{"operationId":"cloud_aliyun_dataworks_public_establish_relation_table_to_business","summary":"Imports a table to a workflow. Calling this operation is equivalent to right-clicking a workflow on the Data…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BusinessId","TableGuid"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can click the wrench icon in the top-right corner to access the workspace management page and view…"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio…"},"BusinessId":{"type":"string","description":"The workflow ID. You can call the https://help.aliyun.com/document_detail/173945.html operation to obtain the workflow ID"},"TableGuid":{"type":"string","description":"The UUID of the table. You can call the https://help.aliyun.com/document_detail/173919.html operation to obtain the table UUID"},"FolderId":{"type":"string","description":"The ID of the folder. You can call the https://help.aliyun.com/document_detail/173952.html or…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/exec-cross-project-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_exec_cross_project_pipeline_run","summary":"Executes a cross-workspace deployment flow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","PipelineRunId"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"PipelineRunId":{"type":"string","description":"The ID of the cross-workspace deployment flow"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/exec-pipeline-run-stage":{"post":{"operationId":"cloud_aliyun_dataworks_public_exec_pipeline_run_stage","summary":"Executes a specified stage of a deployment process","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Code"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the deployment process"},"Code":{"type":"string","description":"The code of the deployment process stage. For the specific value, see the response of the GetPipelineRun operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/execute-adhoc-workflow-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_execute_adhoc_workflow_instance","summary":"Creates a temporary workflow instance based on the specified configurations","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name","ProjectId","Owner","Tasks"],"properties":{"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production. Dev: development"},"Name":{"type":"string","description":"The name"},"ProjectId":{"type":"integer","description":"The project ID"},"Owner":{"type":"string","description":"The account ID of the owner"},"BizDate":{"type":"integer","description":"The business date. The value is a timestamp"},"Tasks":{"type":"string","description":"The list of tasks (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/find-best-match-security-strategy":{"post":{"operationId":"cloud_aliyun_dataworks_public_find_best_match_security_strategy","summary":"Queries the best-matching security policy based on specified conditions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ControlModule":{"type":"string","enum":["DataQuery","DataStudio"],"description":"The control module used to match the security policy type"},"ControlSubModule":{"type":"string","enum":["MyCatalog"],"description":"The control submodule used to match the security policy type"},"WorkspaceId":{"type":"integer","description":"The workspace ID used for exact match of the workspace-level policy"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-agent":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_agent","summary":"Retrieves the details of an agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the skill to retrieve"},"AgentVersion":{"type":"integer","description":"If omitted, the current definition is retrieved. If a published version is specified, the corresponding snapshot and the fixed versions of…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-agent-session-artifact-meta":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_agent_session_artifact_meta","summary":"Retrieves the metadata and content of an artifact based on a session ID and artifact path","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. The value is `2.0`"},"Id":{"type":"string","description":"A client-provided ID that is echoed in the response"},"Params":{"type":"string","description":"The container for business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-agent-session-token-usage":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_agent_session_token_usage","summary":"Retrieves the cumulative AI token usage for a specified session","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. The value is always 2.0"},"Id":{"type":"string","description":"The ID provided by the requester, which is echoed in the response"},"Params":{"type":"string","description":"Business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_alert_rule","summary":"Retrieves a custom monitoring alert rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"The ID of the custom alert rule"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-application-contents":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_application_contents","summary":"Queries the content of resource permission applications under the specified process instance ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProcessInstanceId"],"properties":{"ProcessInstanceId":{"type":"string","description":"The approval process instance ID of the submitted application"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-batch-change-table-owner-status":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_batch_change_table_owner_status","summary":"Queries the status of a batch table owner transfer task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchId"],"properties":{"BatchId":{"type":"string","description":"The ID of the batch transfer task returned by SubmitBatchChangeTableOwner"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-business":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_business","summary":"Queries the details of a business flow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BusinessId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Configuration page to obtain the…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Configuration page to obtain the…"},"BusinessId":{"type":"integer","description":"The ID of the business flow. You can call the https://help.aliyun.com/document_detail/173945.html operation to obtain the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-calendar":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_calendar","summary":"Retrieves the current configuration of a specified scheduling calendar","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the scheduling calendar"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-catalog":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_catalog","summary":"Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks types…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the data catalog entity. Currently, DLF and StarRocks types are supported. For more information, see the response of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-certificate":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_certificate","summary":"Retrieves a certificate file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId"],"properties":{"Id":{"type":"integer","description":"The ID of the certificate file, which is the unique identifier of the certificate file"},"ProjectId":{"type":"integer","description":"The ID of the project to which the certificate file belongs. You can also call the ListProjects operation to query the workspace ID under…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-column":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_column","summary":"Retrieves the details of a specified column in a Data Map table","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID. You can refer to the response of the ListColumns operation and https://help.aliyun.com/document_detail/2880092.html. The format is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-component":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_component","summary":"Gets component information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ComponentId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure…"},"ComponentId":{"type":"string","description":"The component ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-compute-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_compute_resource","summary":"Queries the specified computing resource based on the computing resource ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId"],"properties":{"Id":{"type":"integer","description":"The computing resource ID, which is the unique identifier for the resource"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-compute-resource-auth-user-mappings":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_compute_resource_auth_user_mappings","summary":"Queries the user mappings for compute resources, supporting EMR and Serverless Spark resource types","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ComputeResourceId","ProjectId"],"properties":{"ComputeResourceId":{"type":"integer","description":"The ID of the compute resource"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace to which the data source belongs"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-crawler":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_crawler","summary":"Queries the configuration, status, and latest run information of a specified metadata crawler","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The metadata crawler ID. You can call ListCrawlers to query this ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-crawler-type-capabilities":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_crawler_type_capabilities","summary":"Queries the crawler types supported in the current region, along with their collection scope, scheduling,…","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-create-workflow-instances-result":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_create_workflow_instances_result","summary":"Queries the result of asynchronously creating a workflow instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OperationId"],"properties":{"OperationId":{"type":"string","description":"The operation ID. This parameter is used to query the result of asynchronously creating a workflow instance. You can call the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-cross-project-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_cross_project_pipeline_run","summary":"Queries the details of a cross-workspace deployment flow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","PipelineRunId"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"PipelineRunId":{"type":"string","description":"The cross-workspace deployment flow ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-custom-attribute":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_custom_attribute","summary":"Retrieves a custom attribute definition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The custom attribute ID. The ID must match the regular expression `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. The part after…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-dijob":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_dijob","summary":"Queries the details of a data integration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The instance ID"},"WithDetails":{"type":"string","description":"Specifies whether to return detailed configuration information, which includes TransformationRules, TableMappings, and JobSettings.…"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can call the ListProjects operation to obtain the workspace ID"},"DIJobId":{"type":"integer","description":"[Deprecated] This field is deprecated. Use the Id field instead"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-dijob-log":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_dijob_log","summary":"Retrieves the logs of a data integration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The task ID"},"InstanceId":{"type":"integer","description":"The instance ID"},"FailoverId":{"type":"integer","description":"The failover ID"},"DIJobId":{"type":"integer","description":"[Deprecated] This parameter is deprecated. Use the Id parameter instead"},"PageNumber":{"type":"integer","description":"The page number for paging. The value must be a positive integer greater than or equal to 1"},"NodeType":{"type":"string","description":"The node type. This parameter is applicable only to tasks that run on resource group 2.0. Valid values: MASTER: retrieves the JobManager…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-data-quality-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_data_quality_alert_rule","summary":"Retrieves the details of a data quality alert rule by rule ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The data quality monitoring alert rule ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-data-quality-scan":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_data_quality_scan","summary":"Gets data quality monitoring details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the monitor"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-data-quality-scan-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_data_quality_scan_run","summary":"Queries the run details of a data quality scan task by its ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The data quality monitoring run record ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-data-quality-scan-run-log":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_data_quality_scan_run_log","summary":"Queries the log content of a specified data quality monitoring task instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the data quality monitoring run record"},"Offset":{"type":"integer","description":"The start position of the log, which is the offset relative to the beginning of the file. Unit: bytes. Each query returns a maximum of 512…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-data-quality-template":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_data_quality_template","summary":"Retrieves the details of a data quality rule template by template ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"The data quality rule template ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-data-source":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_data_source","summary":"Queries a specified data source by data source ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The data source ID, which is the unique identifier of the data source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-database":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_database","summary":"Queries the information about a specific database in Data Map","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"Database entity ID. You can refer to the response of the ListDatabases operation and https://help.aliyun.com/document_detail/2880092.html.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-dataset":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_dataset","summary":"Gets the details of a dataset","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-dataset-version":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_dataset_version","summary":"Gets information for a given dataset version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset version ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-deployment-package":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_deployment_package","summary":"Retrieves the details of a deployment package","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DeploymentId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier displayed at the top of the Data Studio page for…"},"DeploymentId":{"type":"integer","description":"The ID of the deployment package. A deployment package ID is generated when you call https://help.aliyun.com/document_detail/173944.html…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_file","summary":"Retrieves the details of a file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console), and go to the…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console), and go to the…"},"FileId":{"type":"integer","description":"The ID of the file. You can invoke the https://help.aliyun.com/document_detail/173942.html API to query the ID of the corresponding file"},"NodeId":{"type":"integer","description":"The ID of the scheduling node. You can invoke the https://help.aliyun.com/document_detail/173942.html API to obtain the node ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-file-version":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_file_version","summary":"Retrieves the version details of a file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileId","FileVersion"],"properties":{"FileId":{"type":"integer","description":"The ID of the file. You can call https://help.aliyun.com/document_detail/173942.html to query the file ID"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can click the small wrench icon in the upper-right corner of the page to go to the workspace…"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier displayed at the top of the Data Studio page for…"},"FileVersion":{"type":"integer","description":"The version of the file to query"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-folder":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_folder","summary":"Queries the information about a folder","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console.…"},"FolderId":{"type":"string","description":"The folder ID. Either this parameter or FolderPath must be specified. You can call the https://help.aliyun.com/document_detail/173955.html…"},"FolderPath":{"type":"string","description":"The folder path. Either this parameter or FolderId must be specified. You can call the https://help.aliyun.com/document_detail/173955.html…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-function":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_function","summary":"Queries the information about a user-defined function (UDF) in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The unique identifier of the UDF function. This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-ideevent-detail":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_ideevent_detail","summary":"Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MessageId","ProjectId"],"properties":{"MessageId":{"type":"string","description":"The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can obtain the ID from the message"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_image","summary":"Retrieves the details of a specified image by image ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"},"ImageVersion":{"type":"string","description":"The image version. If you do not specify this parameter, the latest version is retrieved"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-image-test-result":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_image_test_result","summary":"Retrieves the details of an image test result","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProcessId"],"properties":{"Id":{"type":"string","description":"The image ID"},"ProcessId":{"type":"string","description":"The ID of the test process"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-job-status":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_job_status","summary":"Returns the status of an asynchronous task. After calling an asynchronous API, poll this API to obtain the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobId"],"properties":{"JobId":{"type":"string","description":"The task ID returned after calling an asynchronous API"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-lineage-relationship":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_lineage_relationship","summary":"Retrieves the details of a specified lineage relationship in DataWorks Data Map","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the lineage relationship. You can obtain this ID from the response of the ListLineageRelationships operation"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-mcp-server":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_mcp_server","summary":"Returns the details of an MCP Server","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the MCP Server to retrieve"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_meta_collection","summary":"Queries the information about a collection in Data Map. Collections include categories and data albums","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The collection ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-meta-entity":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_meta_entity","summary":"Retrieves metadata entity details. Currently, only pure custom entity types are supported","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The entity ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-meta-entity-def":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_meta_entity_def","summary":"Retrieves the details of a custom entity definition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EntityType"],"properties":{"EntityType":{"type":"string","description":"The entity type. The value must match the regular expression `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-network":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_network","summary":"Retrieves the details of a network resource","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the network resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-node":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_node","summary":"Queries the information about a node in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio node. This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-parameter":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_parameter","summary":"Gets the details of a parameter by its ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the parameter"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-partition":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_partition","summary":"Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TableId","Name"],"properties":{"TableId":{"type":"string","description":"The table ID. You can refer to the result returned by the ListTables operation and https://help.aliyun.com/document_detail/2880092.html"},"Name":{"type":"string","description":"The partition name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-pipeline-run":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_pipeline_run","summary":"Retrieves the details of a deployment process","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the deployment process"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-process-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_process_definition","summary":"Retrieves the approval policy for a given process definition ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the process definition"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-process-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_process_instance","summary":"Retrieves details for a specified approval process instance, including its approval nodes and task list","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProcessInstanceId"],"properties":{"ProcessInstanceId":{"type":"string","description":"The ID of the process instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-project":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_project","summary":"Queries the details of a DataWorks workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-project-member":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_project_member","summary":"Retrieves the details of a specific member in a Workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","UserId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks Workspace. You can sign in to the DataWorks Console (https://dataworks.console.aliyun.com/workspace/list) and go…"},"UserId":{"type":"string","description":"The ID of the user. To find the ID, sign in to the DataWorks Console (https://dataworks.console.aliyun.com/product/ms_menu), go to the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-project-role":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_project_role","summary":"Queries the details of a workspace role","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Code"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Code":{"type":"string","description":"The code of the workspace role. Valid values: role_project_admin: workspace administrator role_project_dev: developer…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-rerun-workflow-instances-result":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_rerun_workflow_instances_result","summary":"Query the result of an asynchronous rerun workflow instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OperationId"],"properties":{"OperationId":{"type":"string","description":"The operation ID used to asynchronously query the result of the workflow instance rerun. This value is obtained from the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_resource","summary":"Queries the information about a file resource","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the file resource. This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-resource-group":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_resource_group","summary":"Retrieves the details of a specified resource group by ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The unique identifier of the general resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-route":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_route","summary":"Queries the information about a route based on its ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The route ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-schema":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_schema","summary":"Retrieves the details of a specified schema in Data Map. Only MaxCompute and Hologres schemas are supported","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID. You can refer to the ListSchemas operation and https://help.aliyun.com/document_detail/2880092.html. The format is…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-security-strategy":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_security_strategy","summary":"Retrieves the details of a security policy based on the provided security policy ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The security policy ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-semantic-job-detail":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_semantic_job_detail","summary":"Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ExecutorJobId","ProjectId"],"properties":{"ExecutorJobId":{"type":"string","description":"The executor job ID. Use the Data.ExecutorJobId from the RunSemanticJob response or the ExecutorJobId from a ListSemanticJobRuns record"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace to which the job belongs. Use the ProjectId from the CreateSemanticJob response or a ListSemanticJobs…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-semantic-job-log":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_semantic_job_log","summary":"Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ExecutorJobId","ProjectId"],"properties":{"ExecutorJobId":{"type":"string","description":"The executor job ID. Use the Data.ExecutorJobId from the RunSemanticJob response or the ExecutorJobId from a ListSemanticJobRuns record"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace to which the task belongs. Use the ProjectId from the CreateSemanticJob response or a ListSemanticJobs…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-server-ide-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_server_ide_instance","summary":"Queries the details of a specified personal development environment instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The personal development environment instance ID. You can call ListServerIdeInstances to obtain the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-skill":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_skill","summary":"Retrieves the details of a specified Skill by name, including the body of the SKILL.md file and the bundle's…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The unique name of the Skill"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-snapshot":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_snapshot","summary":"Retrieves the details of a version snapshot","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The unique ID of the snapshot"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-table":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_table","summary":"Queries the details of a specified table in DataWorks Data Map. You can choose whether to return business…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID. You can refer to the response of the ListTables operation and https://help.aliyun.com/document_detail/2880092.html. The format is…"},"IncludeBusinessMetadata":{"type":"string","description":"Specifies whether to include business metadata. Default value: false"},"IncludeExtendedProperties":{"type":"string","description":"Specifies whether to return extended properties. If you set this parameter to `true`, extended properties are returned. If you set this…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-task":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_task","summary":"Queries the information about a task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The task ID"},"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The environment of the workspace. Valid values: Prod: production environment Dev: development environment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-task-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_task_instance","summary":"Retrieves the details of a specified task instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The unique identifier of the task instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-task-instance-log":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_task_instance_log","summary":"Queries the run log generated during a specific run of an instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The instance ID"},"RunNumber":{"type":"integer","description":"The sequence number of an instance run. Minimum value: 1. By default, the latest run is used"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-update-task-result":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_update_task_result","summary":"Queries the result of asynchronously creating a workflow instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OperationId"],"properties":{"OperationId":{"type":"string","description":"The operation ID, which is used to query the result of the asynchronous node update. You can obtain this ID from the UpdateTaskAsync…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-workflow":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_workflow","summary":"Queries the information about a workflow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The workflow ID"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The environment of the workspace. Valid values: Prod: production environment Dev: development environment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_workflow_definition","summary":"Queries the information about a workflow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The ID of the workflow. This field is of type Long in SDK versions earlier than 8.0.0 and String in SDK version 8.0.0 and later. This…"},"IncludeScriptContent":{"type":"string","description":"Specifies whether the query result includes the script content of internal nodes in the workflow definition. For nodes with large content,…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/get-workflow-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_get_workflow_instance","summary":"Queries the information about a workflow instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the workflow instance"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/grant-member-project-roles":{"post":{"operationId":"cloud_aliyun_dataworks_public_grant_member_project_roles","summary":"Assigns roles to members in a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","UserId","RoleCodes"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"UserId":{"type":"string","description":"The DataWorks account ID. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/product/ms_menu), choose More >…"},"RoleCodes":{"type":"string","description":"The codes of the roles in the workspace. You can call the https://help.aliyun.com/document_detail/2853930.html operation to query the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/import-certificate":{"post":{"operationId":"cloud_aliyun_dataworks_public_import_certificate","summary":"Imports a certificate file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Name","CertificateFile"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the project to which the certificate file belongs"},"Name":{"type":"string","description":"The name of the certificate file. The name must be unique within a project"},"CertificateFile":{"type":"string","description":"The certificate file to upload. Construct an InputStream to upload the file"},"Description":{"type":"string","description":"The description of the file"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/import-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_import_workflow_definition","summary":"Imports a workflow node defined by FlowSpec and its internal child nodes into Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the workflow. For the specification details, see FlowSpec…"},"DryRun":{"type":"string","description":"Specifies whether to call this operation in validation mode. If this parameter is set to true, only the legality of the input workflow…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/kill-semantic-job":{"post":{"operationId":"cloud_aliyun_dataworks_public_kill_semantic_job","summary":"Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ExecutorJobId","ProjectId"],"properties":{"ExecutorJobId":{"type":"string","description":"The executor job ID of the run to stop. Use the Data.ExecutorJobId value from the RunSemanticJob response or the ExecutorJobId value from…"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace to which the job belongs. Use the ProjectId value from the CreateSemanticJob response or a…"},"RetryTimes":{"type":"integer","description":"The number of retries when sending the stop request to the executor. This parameter is typically optional. If specified, use a…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-agent-session-artifacts":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_agent_session_artifacts","summary":"Queries the list of artifact files produced by a specified session","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. Fixed value: 2.0"},"Id":{"type":"string","description":"The ID passed in by the requester. The value is returned as-is"},"Params":{"type":"string","description":"The business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-agent-sessions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_agent_sessions","summary":"Retrieves the conversation history list of agent sessions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. Fixed to 2.0"},"Id":{"type":"string","description":"The ID passed by the requester, which is returned as is"},"Params":{"type":"string","description":"The business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-agents":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_agents","summary":"Queries the list of agents available to the current tenant, with support for filtering by name and pagination","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. Fixed value: 2.0"},"Id":{"type":"string","description":"The ID passed in by the requester. The value is returned as-is"},"Params":{"type":"string","description":"The specific parameter content for this request (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-alert-rules":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_alert_rules","summary":"Queries a list of custom monitoring alert rules","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageNumber","PageSize"],"properties":{"Owner":{"type":"string","description":"The ID of the Alibaba Cloud account used by the owner of the rule"},"TaskIds":{"type":"string","description":"The IDs of the scheduling tasks (JSON-encoded)"},"Types":{"type":"string","description":"The list of alert types (JSON-encoded)"},"Receiver":{"type":"string","description":"The ID of the Alibaba Cloud account used by the alert recipient"},"Name":{"type":"string","description":"The name of the rule"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-business":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_business","summary":"Queries a list of workflows","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageNumber","PageSize"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must specify either…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You…"},"PageNumber":{"type":"integer","description":"The requested page number, used for pagination"},"PageSize":{"type":"integer","description":"The number of records per page. Default: 10. Maximum: 100"},"Keyword":{"type":"string","description":"The keyword, used for fuzzy match of workflow names"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-calendar-versions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_calendar_versions","summary":"Queries the versions of a specified scheduling calendar","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the scheduling calendar"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Valid values: 1 to 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-calendars":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_calendars","summary":"Queries a list of scheduling calendars","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID. Queries the calendars applicable to this workspace, including those applicable to all workspaces. If this parameter is…"},"Name":{"type":"string","description":"The name of the scheduling calendar. Partial match is supported"},"Owner":{"type":"string","description":"The account ID of the owner. Exact match is supported"},"SortBy":{"type":"string","description":"The sorting rule. The format is \"Field Direction\", separated by a space. Field: ModifyTime, Name, or Id. Direction: Asc for ascending…"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of items per page. Default value: 10. Valid values: 1 to 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-catalogs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_catalogs","summary":"Queries a list of catalogs in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentMetaEntityId"],"properties":{"ParentMetaEntityId":{"type":"string","description":"The parent entity ID. For more information, see https://help.aliyun.com/document_detail/2880092.html. Currently, only the DLF and…"},"Name":{"type":"string","description":"The name. Supports fuzzy matching"},"Comment":{"type":"string","description":"The comment. Supports token-based matching"},"Types":{"type":"string","description":"The type. Supports exact match. If left empty, all types are queried (JSON-encoded)"},"SortBy":{"type":"string","enum":["CreateTime","ModifyTime","Name","Type"],"description":"The sort field. Default value: CreateTime. Valid values: CreateTime ModifyTime Name Type"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The order in which the catalogs are sorted. Default value: Asc. Valid values: Asc: ascending order. Desc: descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of records per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-certificates":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_certificates","summary":"Retrieves a list of certificate files","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the workspace to which the certificate file belongs"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"Name":{"type":"string","description":"The name of the certificate file. Fuzzy match by file name is supported"},"CreateUser":{"type":"string","description":"The ID of the user who created the certificate files"},"StartCreateTime":{"type":"integer","description":"The time when the certificate file was created. You can call this operation to query the files that are created after the time. Unit:…"},"EndCreateTime":{"type":"integer","description":"The time when the certificate file was created. You can call this operation to query the files that are created before the time. Unit:…"},"SortBy":{"type":"string","description":"The field used to sort the certificate files. Valid values: CreateTime Id Name Default value: Id"},"Order":{"type":"string","description":"The order in which you want to sort the certificate files. Valid values: Desc: descending order Asc: ascending order Default value: Asc"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-columns":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_columns","summary":"Queries the columns of a specified table in DataWorks Data Map","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TableId"],"properties":{"TableId":{"type":"string","description":"The table ID. You can obtain the ID from the response of the ListTables operation. For more information, see…"},"Name":{"type":"string","description":"The name of the column. Fuzzy match is supported"},"Comment":{"type":"string","description":"The comment on the column. Fuzzy match is supported"},"SortBy":{"type":"string","enum":["Name","Position"],"description":"The field used for sorting. Default value: Position. Valid values: Name: Name. Position: Position"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default value: Asc. Valid values: Asc: Ascending order. Desc: Descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"IncludeExtendedProperties":{"type":"string","description":"Specifies whether to return extended properties. If you set this parameter to `true`, extended properties are returned. If you set this…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-components":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_components","summary":"Retrieves a list of components","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The ID of the workspace associated with the data source. You can call the https://help.aliyun.com/document_detail/178393.html operation to…"},"Name":{"type":"string","description":"The name of the data source"},"PageNumber":{"type":"integer","description":"The page number for pagination"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-compute-resources":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_compute_resources","summary":"Queries the list of computing resources that meet the specified business information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace"},"Name":{"type":"string","description":"The name of the computing resource"},"Types":{"type":"string","description":"The filter for computing resource types. You can configure multiple types for filtering (JSON-encoded)"},"EnvType":{"type":"string","description":"The environment type of the computing resource. Valid values: Dev: development environment. Prod: production environment"},"PageNumber":{"type":"integer","description":"The page number to query. The default value is 1, which indicates the first page"},"PageSize":{"type":"integer","description":"The number of entries per page. The default value is 10, and the maximum value is 100"},"SortBy":{"type":"string","description":"The field to sort the computing resource list by. Supported fields include name, creation time, and computing resource ID. CreateTime:…"},"Order":{"type":"string","description":"The sort direction of the computing resource list. Valid values: Desc: descending order. Asc: ascending order. Default value: Desc"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-crawler-runs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_crawler_runs","summary":"Queries the run records of a specified metadata crawler by paging, with optional filtering by time range and…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the metadata crawler. You can call ListCrawlers to obtain the ID"},"StartTimeFrom":{"type":"integer","description":"The lower bound of the run start time, in millisecond-level UNIX timestamp. The value must be within the last 30 days. If not specified,…"},"StartTimeTo":{"type":"integer","description":"The upper bound of the run start time, in millisecond-level UNIX timestamp. The value must be within the last 30 days. If not specified,…"},"Status":{"type":"string","description":"The run status. Valid values: WAITING, RUNNING, SUCCESS, ERROR, SHUTDOWN"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 20. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-crawler-types":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_crawler_types","summary":"Queries a list of metadata crawler types supported in Data Map. The subtypes of the types and the…","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-crawlers":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_crawlers","summary":"Queries metadata crawlers by paged query, and supports filtering by workspace, data source, type,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"DataSourceIds":{"type":"string","description":"The list of data source IDs. Up to 10 IDs are supported (JSON-encoded)"},"Type":{"type":"string","description":"The crawler type. Call GetCrawlerTypeCapabilities to query the valid values supported in the current region"},"EnvType":{"type":"string","description":"The DataWorks environment type. Dev indicates the development environment. Prod indicates the production environment"},"Owner":{"type":"string","description":"The DataWorks user ID of the crawler owner"},"Name":{"type":"string","description":"The metadata crawler name. Supports fuzzy match"},"PageNumber":{"type":"integer","description":"The page number. Starts from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 20. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-cross-project-deployment-candidates":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_cross_project_deployment_candidates","summary":"Queries cross-workspace deployment candidate objects","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","DeploymentEnvironmentId"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"DeploymentEnvironmentId":{"type":"integer","description":"The cross-workspace deployment environment ID"},"ObjectId":{"type":"string","description":"The candidate object ID"},"ObjectType":{"type":"string","description":"The candidate object type"},"ChangeType":{"type":"string","description":"The change type"},"Keyword":{"type":"string","description":"The search keyword"},"CommitUser":{"type":"string","description":"The committer"},"CommitTimeFrom":{"type":"integer","description":"The start of the commit time range. This value is a UNIX timestamp in milliseconds"},"CommitTimeTo":{"type":"integer","description":"The end of the commit time range. This value is a UNIX timestamp in milliseconds"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-cross-project-deployment-environments":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_cross_project_deployment_environments","summary":"Queries cross-workspace deployment environments","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The project workspace ID"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-cross-project-pipeline-run-items":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_cross_project_pipeline_run_items","summary":"Queries the publish items of a cross-workspace publish pipeline","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","PipelineRunId"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"PipelineRunId":{"type":"string","description":"The ID of the cross-workspace publish pipeline"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-cross-project-pipeline-runs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_cross_project_pipeline_runs","summary":"Queries the list of cross-workspace publish flows","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The workspace ID"},"DeploymentEnvironmentId":{"type":"integer","description":"The cross-workspace publish environment ID"},"ObjectId":{"type":"string","description":"The publish object ID"},"ObjectType":{"type":"string","description":"The publish object type"},"Status":{"type":"string","enum":["Building","Ready","Running","Success","Fail","Termination"],"description":"The publish flow status. Valid values: Building: Building. Ready: Ready and waiting for execution. Running: Running. Termination:…"},"Creator":{"type":"string","description":"The creator"},"Executor":{"type":"string","description":"The executor"},"CreateTimeFrom":{"type":"integer","description":"The start of the creation time range. This value is a UNIX timestamp in milliseconds"},"CreateTimeTo":{"type":"integer","description":"The end of the creation time range. This value is a UNIX timestamp in milliseconds"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-custom-agents":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_custom_agents","summary":"Lists custom agents with pagination","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"integer","description":"The maximum number of entries to return for this request"},"NextToken":{"type":"string","description":"The pagination token. Do not specify this parameter for the first query. For subsequent queries, specify the `NextToken` value returned…"},"Q":{"type":"string","description":"The search keyword used to perform a fuzzy match on agent names"},"Visibility":{"type":"string","description":"The visibility levels used to filter results. You can specify multiple values (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-custom-attributes":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_custom_attributes","summary":"Queries the list of custom attribute definitions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"DisplayName":{"type":"string","description":"The display name of the custom attribute. The value is matched by plain text containment"},"EntityTypes":{"type":"string","description":"The entity types to which the custom attribute applies. Separate multiple entity types with commas, such as `*-table,*-column`. Specific…"},"Comment":{"type":"string","description":"The description of the custom attribute. The value is fuzzy matched"},"SortBy":{"type":"string","enum":["Name","Type","CreateTime","ModifyTime"],"description":"The sort field. Valid values: CreateTime and ModifyTime"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Valid values: Asc and Desc"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-dialarm-rules":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_dialarm_rules","summary":"Views alert rules configured for a synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"JobId":{"type":"integer","description":"The ID of the task for which alert rules are configured"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"DIAlarmRuleId":{"type":"integer","description":"The ID of the alert rule. If you leave this parameter empty, all alert rules of the task are queried"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-dijob-events":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_dijob_events","summary":"Queries events for a synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EventType","StartTime","EndTime"],"properties":{"DIJobId":{"type":"integer","description":"The ID of the synchronization task"},"EventType":{"type":"string","description":"The type of event that you want to query. Valid values: Failover, Alarm, and DDL"},"StartTime":{"type":"integer","description":"The beginning of the time range to query"},"EndTime":{"type":"integer","description":"The end of the time range to query"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-dijob-metrics":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_dijob_metrics","summary":"Queries metrics for a synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["StartTime","EndTime","MetricName"],"properties":{"DIJobId":{"type":"integer","description":"The instance ID"},"StartTime":{"type":"integer","description":"The beginning of the time range to query"},"EndTime":{"type":"integer","description":"The end of the time range to query"},"MetricName":{"type":"string","description":"The metrics that you want to query (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-dijob-run-details":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_dijob_run_details","summary":"Queries the running information about a synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DIJobId"],"properties":{"DIJobId":{"type":"integer","description":"The ID of the synchronization task"},"InstanceId":{"type":"integer","description":"The instance ID"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"SourceDataSourceName":{"type":"string","description":"The name of the source"},"SourceDatabaseName":{"type":"string","description":"The name of the database in the source"},"SourceSchemaName":{"type":"string","description":"The name of the schema of the source"},"SourceTableName":{"type":"string","description":"The name of the table in the source"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-dijobs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_dijobs","summary":"Lists new-version Data Integration tasks, including real-time database synchronization tasks, batch database…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"PageNumber":{"type":"integer","description":"The page number. Pages are numbered starting from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default: 10. Maximum: 100"},"Name":{"type":"string","description":"The name of the Data Integration job. The name must be unique within the DataWorks workspace"},"SourceDataSourceType":{"type":"string","description":"The type of the source data source. If you do not specify this parameter, jobs are not filtered by this criterion. Valid values:…"},"DestinationDataSourceType":{"type":"string","description":"The type of the destination data source. If you do not specify this parameter, jobs are not filtered by this criterion. Valid values:…"},"MigrationType":{"type":"string","description":"The synchronization type. Valid values: `FullAndRealtimeIncremental`: full and real-time incremental synchronization…"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace"},"SpecType":{"type":"string","description":"The configuration type of the job. Valid values: `FILESPEC`, `CLASSIC`, and `ALL`. `FILESPEC` indicates a new job type configured based on…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-asset-tags":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_asset_tags","summary":"Queries a list of tags","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Key":{"type":"string","description":"The tag key"},"Category":{"type":"string","enum":["Normal","System"],"description":"The tag type. Normal System"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-assets":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_assets","summary":"Performs a paging query on DataWorks data assets associated with tags","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Tags":{"type":"string","description":"The list of tags associated with the data assets. This parameter is used to filter query results based on tags: Multiple values are…"},"DataAssetIds":{"type":"string","description":"The list of unique IDs of the data assets (JSON-encoded)"},"DataAssetType":{"type":"string","enum":["ACS::DataWorks::Table","ACS::DataWorks::Task"],"description":"The asset type of the data asset. DataWorks table (ACS::DataWorks::Table) DataWorks scheduled task (ACS::DataWorks::Task)"},"ProjectId":{"type":"integer","description":"The ID of the workspace"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The workspace environment to which the data asset belongs. Valid values: Dev: development environment Prod: production environment"},"AssetDomainId":{"type":"integer","description":"The ID of the asset domain"},"CategoryUuid":{"type":"string","description":"The ID of the asset category"},"Name":{"type":"string","description":"The name of the asset. Fuzzy search by name is supported"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-quality-alert-rules":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_quality_alert_rules","summary":"Queries the list of data quality alert rules in a project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","PageNumber","PageSize"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"DataQualityScanId":{"type":"integer","description":"The ID of the data quality monitor that the alert rule targets"},"SortBy":{"type":"string","description":"The list of sorting fields. Supports fields such as last modified time and creation time. Format: \"SortField+SortOrder (Desc/Asc)\", where…"},"PageNumber":{"type":"integer","description":"The page number of the results"},"PageSize":{"type":"integer","description":"The number of records to return on each page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-quality-scan-runs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_quality_scan_runs","summary":"Queries the data quality scan run records of a specified project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"DataQualityScanId":{"type":"integer","description":"The data quality monitoring ID"},"CreateTimeFrom":{"type":"integer","description":"The earliest start time of the data quality monitoring run"},"CreateTimeTo":{"type":"integer","description":"The latest start time of the data quality monitoring run"},"Status":{"type":"string","enum":["Error","Fail","Kill","Pass","Running","Warn"],"description":"The status of the data quality check result. Valid values: Pass Running Error Fail Warn"},"SortBy":{"type":"string","description":"The list of sort fields. Fields such as modification time and creation time are supported. The format is \"SortField+SortOrder(Desc/Asc)\".…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"ProjectId":{"type":"integer","description":"The project ID"},"Filter":{"type":"string","description":"The extension query filter. The following filter parameters are supported: TaskInstanceId: the scheduled task instance ID. RunNumber: the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-quality-scans":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_quality_scans","summary":"Queries the list of data quality scan tasks in a project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PageSize","PageNumber","ProjectId"],"properties":{"Name":{"type":"string","description":"The data quality scan task name for fuzzy match"},"SortBy":{"type":"string","description":"The list of sorting fields. Supports fields such as last modified time and creation time. Format: \"SortField+SortOrder (Desc/Asc)\", where…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"ProjectId":{"type":"integer","description":"The project ID"},"Table":{"type":"string","description":"Fuzzy match for the monitored table name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-quality-templates":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_quality_templates","summary":"Queries the list of data quality rule templates in a specified project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Catalog":{"type":"string","description":"The catalog path to which the data quality template belongs"},"ProjectId":{"type":"integer","description":"The project ID"},"Name":{"type":"string","description":"The template rule name for fuzzy match"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-source-shared-rules":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_source_shared_rules","summary":"Retrieves a list of sharing rules for a data source","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DataSourceId"],"properties":{"DataSourceId":{"type":"integer","description":"The data source ID"},"TargetProjectId":{"type":"integer","description":"The ID of the workspace to which the data source is shared. You cannot share the data source to the workspace with which the data source…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-data-sources":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_data_sources","summary":"Retrieves a list of data sources that match the specified filter conditions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Name":{"type":"string","description":"The name of the data source. Fuzzy match by data source name is supported"},"Types":{"type":"string","description":"The data source types. This parameter specifies a filter condition. You can specify multiple data source types (JSON-encoded)"},"EnvType":{"type":"string","description":"The environment in which the data sources are used. Valid values: Dev: development environment Prod: production environment"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"SortBy":{"type":"string","description":"The field that you want to use to sort the data sources. Valid values: CreateTime: creation time Id: data source ID Name: data source name…"},"Order":{"type":"string","description":"The order in which you want to sort the data sources. Valid values: Desc: descending order Asc: ascending order Default value: Desc"},"Tags":{"type":"string","description":"The tag of the data source. This parameter specifies a filter condition. You can specify multiple tags, which are in the logical AND…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-databases":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_databases","summary":"Queries a list of databases in an instance, cluster, or data catalog in Data Map. For DLF or StarRocks data…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentMetaEntityId"],"properties":{"ParentMetaEntityId":{"type":"string","description":"The parent entity ID. For more information, see https://help.aliyun.com/document_detail/2880092.html. You can refer to the…"},"Name":{"type":"string","description":"The name. Supports fuzzy match"},"Comment":{"type":"string","description":"The comment. Supports fuzzy match"},"SortBy":{"type":"string","enum":["CreateTime","ModifyTime","Name"],"description":"The sort field. Default value: CreateTime. Valid values: CreateTime ModifyTime Name"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default value: Asc. Valid values: Asc: ascending. Desc: descending"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of records per page. Default: 10. Maximum: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-dataset-versions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_dataset_versions","summary":"Retrieves the version list for a given dataset","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DatasetId"],"properties":{"DatasetId":{"type":"string","description":"The dataset ID"},"CreatorId":{"type":"string","description":"The creator ID"},"SortBy":{"type":"string","enum":["CreateTime","ModifyTime","VersionNumber"],"description":"The sort field. Default: VersionNumber. Valid values: ModifyTime: Modification time. CreateTime: Creation time. VersionNumber: Version…"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default: Desc. Valid values: Asc: Ascending. Desc: Descending"},"PageNumber":{"type":"integer","description":"The page number. Default: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default: 10. Maximum: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-datasets":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_datasets","summary":"Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"Origin":{"type":"string","description":"The dataset source. Valid values: DataWorks PAI"},"Name":{"type":"string","description":"The dataset name. Supports fuzzy search"},"DataTypeList":{"type":"string","description":"The data type. Multiple selections are allowed. Valid values: COMMON PIC TEXT TABLE VIDEO AUDIO INDEX (JSON-encoded)"},"StorageTypeList":{"type":"string","description":"The storage type. Multiple selections are allowed. Supported values: OSS NAS: General-purpose NAS file systems EXTREMENAS: Extreme NAS…"},"CreatorId":{"type":"string","description":"The creator ID"},"SortBy":{"type":"string","enum":["Name","CreateTime","ModifyTime"],"description":"The sort field. Default: CreateTime. Valid values: ModifyTime: Modification time. CreateTime: Creation time. Name"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default: Desc. Valid values: Asc: Ascending. Desc: Descending"},"PageNumber":{"type":"integer","description":"The page number. Default: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default: 10. Maximum: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-deployment-package-files":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_deployment_package_files","summary":"Retrieves the list of file versions pending deployment","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"BusinessId":{"type":"integer","description":"The ID of the workflow. You can call the https://help.aliyun.com/document_detail/173945.html operation to query the ID of the workflow by…"},"SolutionId":{"type":"integer","description":"The Solutions ID"},"CommitFrom":{"type":"string","description":"The start date for the commit, in the format yyyy-MM-dd"},"CommitTo":{"type":"string","description":"The end date for the commit (inclusive), in the format yyyy-MM-dd"},"CommitUserId":{"type":"string","description":"The user ID of the committer"},"FileType":{"type":"integer","description":"The code type of the file. Different file types have different codes. For more information, see…"},"ChangeType":{"type":"integer","description":"The change type. Valid values: 0: added. 1: updated. 2: deleted"},"FileIds":{"type":"string","description":"The list of file IDs to query (JSON-encoded)"},"FileName":{"type":"string","description":"The name of the file"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-deployment-packages":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_deployment_packages","summary":"Queries a list of deployment packages","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier displayed in the workspace switcher at the top of the…"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the…"},"Creator":{"type":"string","description":"The Alibaba Cloud account UID of the deployment package creator"},"EndCreateTime":{"type":"integer","description":"The maximum timestamp in milliseconds for the creation time of the deployment package"},"Executor":{"type":"string","description":"The Alibaba Cloud account UID of the deployment package executor"},"EndExecuteTime":{"type":"integer","description":"The maximum timestamp in milliseconds for the execution start time of the deployment package"},"Status":{"type":"integer","description":"The current status of the deployment package. Valid values: 0: The deployment package is ready. 1: The deployment package is published. 2:…"},"Keyword":{"type":"string","description":"The keyword in the deployment package name. DataWorks supports fuzzy match. You can enter a keyword to query deployment packages whose…"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-downstream-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_downstream_task_instances","summary":"Retrieves a paginated list of downstream instances for a specified instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The instance ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-downstream-tasks":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_downstream_tasks","summary":"Queries a list of descendant tasks of a task by page","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The task ID"},"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The environment of the workspace. Valid values: Prod: production environment Dev: development environment"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-entities-in-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_entities_in_meta_collection","summary":"Queries a list of entities in a collection in Data Map. Collections include categories and data albums.…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The collection ID"},"EntityType":{"type":"string","description":"The entity type"},"EntityName":{"type":"string","description":"The entity name. Supports fuzzy matching"},"EntityDescription":{"type":"string","description":"The description specified when the entity was added to the collection. Supports fuzzy matching. Valid only for the album type"},"SortBy":{"type":"string","description":"The sort field. Valid values: Name (default) CreateTime"},"Order":{"type":"string","description":"The sort order. Valid values: Asc (default): ascending order. Desc"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of records per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-file-versions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_file_versions","summary":"Queries the version list of a file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileId"],"properties":{"FileId":{"type":"integer","description":"The ID of the file. You can call https://help.aliyun.com/document_detail/173942.html to query the file ID"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can click the small wrench icon in the upper-right corner of the page to go to the workspace…"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier displayed in the workspace switcher at the top of the…"},"PageNumber":{"type":"integer","description":"The page number. Used for paging"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-files":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_files","summary":"Queries a list of files by calling ListFiles","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"FileFolderPath":{"type":"string","description":"The path of the folder where the file is stored"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Keyword":{"type":"string","description":"The keyword of the file name. Fuzzy match is supported. You can enter a keyword to query all files whose names contain the keyword"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"PageNumber":{"type":"integer","description":"The page number for pagination"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"UseType":{"type":"string","description":"The functional module to which the file belongs. Valid values: NORMAL: Data Studio. MANUAL: manual node. MANUAL_BIZ: manual workflow.…"},"FileTypes":{"type":"string","description":"The code type of the file. Common codes and their corresponding file types include 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data…"},"Owner":{"type":"string","description":"The owner of the file"},"NodeId":{"type":"integer","description":"The ID of the scheduling node. You can call the https://help.aliyun.com/document_detail/173979.html operation to obtain the node ID"},"NeedContent":{"type":"string","description":"Specifies whether the query result includes the file content. For files with large content, network transmission latency may be significant"},"NeedAbsoluteFolderPath":{"type":"string","description":"Specifies whether the query result includes the path of the folder where the file is stored"},"ExactFileName":{"type":"string","description":"The file name for exact match. The file name in the query result exactly matches this parameter value"},"FileIdIn":{"type":"string","description":"The list of file IDs. The file IDs in the query result can only be a subset of this list. A maximum of 50 file IDs can be specified at a…"},"LastEditUser":{"type":"string","description":"The Alibaba Cloud ID of the user who last updated the file"},"CommitStatus":{"type":"integer","description":"The current commit status of the file. Valid values: 0 (the latest code has not been committed) and 1 (the latest code has been committed)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-folders":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_folders","summary":"Queries a list of folders","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentFolderPath","PageNumber","PageSize"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the…"},"ParentFolderPath":{"type":"string","description":"The path of the parent folder"},"PageNumber":{"type":"integer","description":"The page number for pagination"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-functions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_functions","summary":"Retrieves a paginated list of UDF functions in Data Studio. You can also use filter conditions to filter UDF…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Owner":{"type":"string","description":"The filter condition: the ID of the UDF function owner"},"Type":{"type":"string","description":"The filter condition: the function type. Valid values: Math: mathematical operation function Aggregate: aggregate functions String:…"},"Name":{"type":"string","description":"The filter condition: the UDF function name. Fuzzy match is supported"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1. Minimum value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-image-associated-projects":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_image_associated_projects","summary":"Lists the workspaces associated with an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-image-test-results":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_image_test_results","summary":"Queries a list of image test results","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNumber":{"type":"integer","description":"The page number"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-image-versions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_image_versions","summary":"Gets the details of a specified image version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-images":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_images","summary":"Retrieves a list of images","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"The image name used for fuzzy match"},"Statuses":{"type":"string","description":"The list of image statuses to query (JSON-encoded)"},"Stages":{"type":"string","description":"The list of image publishing stages to query (JSON-encoded)"},"Accessibility":{"type":"string","description":"The accessibility of the image. Valid values: Public: The image is visible to all users. Private: The image is visible only to the creator"},"ProjectIds":{"type":"string","description":"The list of workspace IDs (JSON-encoded)"},"SupportedModules":{"type":"string","description":"The list of supported modules (JSON-encoded)"},"SupportedTaskTypes":{"type":"string","description":"The list of supported task types (JSON-encoded)"},"ProviderTypes":{"type":"string","description":"The list of image reference data types (JSON-encoded)"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNumber":{"type":"integer","description":"The page number"},"SortBy":{"type":"string","description":"The list of sort fields. Fields such as scheduled time and start time are supported. The format is \"sort field + sort order (Desc/Asc)\".…"},"SearchAll":{"type":"string","description":"Specifies whether to search for all images"},"Official":{"type":"string","description":"Specifies whether the image is an official image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-lineage-relationships":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_lineage_relationships","summary":"Queries the list of data lineage relationships between two given entities (such as tables, fields, or OSS…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SrcEntityId","DstEntityId"],"properties":{"SrcEntityId":{"type":"string","description":"The ID of the source entity. You can refer to the table or field ID returned by the ListTables or ListColumns operation, or use a custom…"},"DstEntityId":{"type":"string","description":"The ID of the destination entity. You can refer to the table or field ID returned by the ListTables or ListColumns operation, or use a…"},"SrcEntityName":{"type":"string","description":"The name of the source entity. Fuzzy match is supported"},"DstEntityName":{"type":"string","description":"The name of the destination entity. Fuzzy match is supported"},"SortBy":{"type":"string","enum":["Name"],"description":"The field used for sorting. Default value: Name"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default value: Asc. Valid values: Asc: ascending order. Desc: descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-lineages":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_lineages","summary":"Queries the upstream and downstream lineage entities for a specified entity in Data Map, with an option to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SrcEntityId":{"type":"string","description":"The source entity ID. You can refer to the table or column ID returned by the ListTables or ListColumns operation, or use a custom entity ID"},"DstEntityId":{"type":"string","description":"The destination entity ID. You can refer to the table or column ID returned by the ListTables or ListColumns operation, or use a custom…"},"SrcEntityName":{"type":"string","description":"The source entity name. Fuzzy matching is supported"},"DstEntityName":{"type":"string","description":"The destination entity name. Fuzzy matching is supported"},"NeedAttachRelationship":{"type":"string","description":"Specifies whether to return lineage relationship information. Default value: false"},"SortBy":{"type":"string","enum":["Name"],"description":"The sort field. Default value: Name. The entities are sorted by lineage entity name"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default value: Asc. Valid values: Asc: Ascending order. Desc: Descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"RecentDays":{"type":"integer","description":"Queries the lineage relationships that take effect within the specified number of recent calendar days. Valid values: 1 to 30. For…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-mcp-servers":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_mcp_servers","summary":"Retrieves a paginated list of MCP servers","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Q":{"type":"string","description":"The search keyword for a fuzzy search on MCP Server names"},"Visibility":{"type":"string","description":"The visibility levels for filtering the results. You can specify multiple levels (JSON-encoded)"},"MaxResults":{"type":"integer","description":"The maximum number of results to return per page"},"NextToken":{"type":"string","description":"The next page token from a previous response. Use this token to retrieve the next page of results. Leave this parameter empty for the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-meta-collections":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_meta_collections","summary":"Queries the list of Data Map collections. Supports querying both Data Map categories and data albums","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Type"],"properties":{"Type":{"type":"string","enum":["Category","Album","AlbumCategory"],"description":"The collection type. Valid values: Category: category. Album: data album. AlbumCategory: album subcategory"},"ParentId":{"type":"string","description":"The ID of the parent node collection object"},"Name":{"type":"string","description":"The collection name. Fuzzy match is supported"},"Description":{"type":"string","description":"The collection description. Fuzzy match is supported"},"CreateUser":{"type":"string","description":"The user ID of the creator. This parameter is valid only for the album type. Default value: the current user ID"},"Administrator":{"type":"string","description":"The ID of the collection administrator. This parameter is valid only for the album type. Default value: the current user ID"},"SortBy":{"type":"string","description":"The sort field. Valid values: Id (default) Name: name. CreateUser: creator ID. CreateTime: creation time. ModifyTime: modification time"},"Order":{"type":"string","description":"The sort direction. Valid values: Asc (default) Desc"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The page size. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-meta-entities":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_meta_entities","summary":"Queries a list of metadata entities. Currently, only custom entity types are supported","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EntityType"],"properties":{"EntityType":{"type":"string","description":"The entity type"},"MaxResults":{"type":"integer","description":"The maximum number of results per page. Default value: 10. Maximum value: 100"},"NextToken":{"type":"string","description":"The pagination token. Do not specify this parameter for the first request. For subsequent requests, use the NextToken value returned in…"},"Name":{"type":"string","description":"The entity name filter. Performs keyword-contains matching"},"Comment":{"type":"string","description":"The comment filter. Performs token matching"},"AttributeFilters":{"type":"string","description":"The entity attribute filter conditions. Multiple filter conditions have an AND relationship. Multiple values within the same filter…"},"CustomAttributeFilters":{"type":"string","description":"The custom attribute filter conditions. Multiple filter conditions have an AND relationship. Multiple values within the same filter…"},"SortBy":{"type":"string","enum":["Name","CreateTime","ModifyTime"],"description":"The sort field"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort direction"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-meta-entity-defs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_meta_entity_defs","summary":"Queries the list of custom entity definitions, including custom entity types and extension table types","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"DisplayName":{"type":"string","description":"The display name of the type definition. Matched by plain text containment"},"Description":{"type":"string","description":"The description. Matched by fuzzy match"},"Extend":{"type":"string","enum":["NONE","TABLE"],"description":"The extension mode filter. Valid values: NONE: custom entity only. TABLE: extension table entity"},"SortBy":{"type":"string","enum":["Name","CreateTime","ModifyTime"],"description":"The field by which to sort the results. Valid values: Name: sorted by name. CreateTime: sorted by creation time. ModifyTime: sorted by…"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort direction. Valid values: Asc: ascending order. Desc: descending order"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-my-applications":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_my_applications","summary":"Queries all resource access permission application orders initiated by the current user","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DefSchema","ResourceType","StartTime","EndTime"],"properties":{"DefSchema":{"type":"string","description":"Filters by resource type. Note: The resource types supported by the system for applications are constrained by ResourceSchema…"},"ResourceType":{"type":"string","description":"Filters by minimum permission resource type. Note: The minimum permission resource type is constrained by ResourceSchema…"},"Resource":{"type":"string","description":"Filters by resource with exact or generalized matching. The resource description is constrained by ResourceSchema…"},"StartTime":{"type":"integer","description":"The start time of the application period (millisecond timestamp)"},"EndTime":{"type":"integer","description":"The end time of the application period (millisecond timestamp)"},"Statuses":{"type":"string","description":"Filters by approval status. Valid values: WaitApproval: pending approval. Confirmed: pending authorization. RejectApproval: approval…"},"NextToken":{"type":"string","description":"The pagination cursor"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 200"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-my-related-approvals":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_my_related_approvals","summary":"Query all permission application orders where the current user is an approver or stakeholder","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DefSchema","ResourceType"],"properties":{"DefSchema":{"type":"string","description":"Filter by resource type. Note: The resource types supported by the system for applications are constrained by ResourceSchema…"},"ResourceType":{"type":"string","description":"Filter by minimum permission resource type. Note: The minimum permission resource type is constrained by ResourceSchema…"},"Resource":{"type":"string","description":"Filter by resource with exact/generalized matching. The resource description is constrained by ResourceSchema…"},"StartTime":{"type":"integer","description":"Application time start (millisecond timestamp)"},"EndTime":{"type":"integer","description":"Application time end (millisecond timestamp)"},"Statuses":{"type":"string","description":"Filter by approval status. Enum values: WaitApproval: Pending approval Confirmed: Pending authorization RejectApproval: Approval rejected…"},"Grantee":{"type":"string","description":"Filter by authorization principal. Note: The authorization principal types supported by the system are constrained by ResourceSchema…"},"AccessTypes":{"type":"string","description":"Filter by requested permissions. Note: Different resource levels support different application permission types, all constrained by…"},"NextToken":{"type":"string","description":"Pagination cursor"},"PageSize":{"type":"integer","description":"Page size (default 10, maximum 200)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-networks":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_networks","summary":"Queries the network resources in a resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId"],"properties":{"ResourceGroupId":{"type":"string","description":"The unique identifier of the general resource group"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNumber":{"type":"integer","description":"The page number"},"SortBy":{"type":"string","description":"The sort fields. Supports fields such as scheduled time and start time. The format is sort field + sort order (Desc/Asc), where Asc can be…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-node-dependencies":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_node_dependencies","summary":"Retrieves the dependent nodes of a specified data development node in a paginated manner","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the data development node. This field is of the Long type in SDK versions earlier than 8.0.0, and of the String…"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-nodes":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_nodes","summary":"Retrieves a list of data development nodes with paging. You can also perform a filtered query on the list by…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Scene":{"type":"string","description":"The scenario to which the node belongs. This parameter is used as a filter condition. If you do not specify this parameter, leave it…"},"ContainerId":{"type":"string","description":"The ID of the container. This parameter is used as a filter condition to query nodes in a specified container. If you do not specify this…"},"Recurrence":{"type":"string","description":"The scheduling type. This parameter is used as a filter condition. Valid values: Normal: The node runs as expected. Pause: The node is…"},"RerunMode":{"type":"string","description":"The rerun mode. If you do not specify this parameter, leave it empty. Valid values: Allowed: The node can be rerun regardless of whether…"},"Name":{"type":"string","description":"The name of the node. Fuzzy match is supported"},"PageNumber":{"type":"integer","description":"The page number of the requested data"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-parameter-versions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_parameter_versions","summary":"Lists parameter versions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The parameter ID"},"SortBy":{"type":"string","description":"Specifies the sort criterion in the format \\ \\ . You can omit Asc for ascending order. The only valid value for the sort field is: Version…"},"PageSize":{"type":"integer","description":"Specifies the number of entries to return per page. Default value: 20"},"PageNumber":{"type":"integer","description":"Specifies the page number of the results to return. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-parameters":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_parameters","summary":"Queries the list of query parameters","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The ID of the workspace. You can call the ListProjects operation to obtain the workspace ID"},"Scope":{"type":"string","enum":["Project"],"description":"The scope of the parameter. Default value: Project. Other types are not supported"},"Type":{"type":"string","enum":["PlainConstant","SecretConstant","Variable"],"description":"The parameter type. Valid values: PlainConstant: plaintext constant. SecretConstant: ciphertext constant. Variable: variable"},"Ids":{"type":"string","description":"The list of parameter IDs (JSON-encoded)"},"Names":{"type":"string","description":"The list of parameter names (JSON-encoded)"},"Owner":{"type":"string","description":"The account ID of the owner"},"SortBy":{"type":"string","description":"The list of fields by which to sort the results. Supported fields include modification time and creation time. The format is…"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Default value: 20"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-partitions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_partitions","summary":"Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TableId"],"properties":{"TableId":{"type":"string","description":"The ID of the table. You can obtain this value from the response of the https://help.aliyun.com/document_detail/2880092.html operation.…"},"Name":{"type":"string","description":"The partition name. Fuzzy match is supported. This parameter is valid only for MaxCompute tables"},"SortBy":{"type":"string","enum":["CreateTime","ModifyTime","Name","RecordCount","DataSize"],"description":"The field by which to sort the results. Default value: CreateTime. Valid values: CreateTime: the creation time. Only MaxCompute tables are…"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort direction. Default value: Asc. Valid values: Asc: ascending order. Desc: descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-pending-approvals":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_pending_approvals","summary":"Retrieves the list of pending permission request orders for which the current user is the approver","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["DefSchema","ResourceType"],"properties":{"DefSchema":{"type":"string","description":"Filters by resource type. Note: The supported resource types for requests are constrained by ResourceSchema…"},"ResourceType":{"type":"string","description":"Filters by minimum permission resource type. Note: The minimum permission resource type is constrained by ResourceSchema…"},"Resource":{"type":"string","description":"Filters by resource with exact or generalized matching. Resource descriptions are constrained by ResourceSchema…"},"StartTime":{"type":"integer","description":"Start time of the application period (millisecond timestamp)"},"EndTime":{"type":"integer","description":"End time of the application period (millisecond timestamp)"},"Grantee":{"type":"string","description":"Filters by authorization principal. Note: The supported authorization principal types are constrained by ResourceSchema…"},"AccessTypes":{"type":"string","description":"Filters by requested permissions. Note: Different resource levels support different permission types. All are uniformly constrained by…"},"NextToken":{"type":"string","description":"Cursor"},"PageSize":{"type":"integer","description":"Page size (default: 10, maximum: 200)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-pipeline-run-items":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_pipeline_run_items","summary":"Queries the information about deployment objects by deployment process ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","PipelineRunId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console"},"PipelineRunId":{"type":"string","description":"The workflow task ID. To obtain the ID, see https://help.aliyun.com/document_detail/438042.html"},"PageNumber":{"type":"integer","description":"The page number, for pagination"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-pipeline-runs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_pipeline_runs","summary":"Retrieve a paginated list of deployment processes. You can also filter this list based on specific criteria","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can obtain this ID from the Workspace Management page in the DataWorks console…"},"Creator":{"type":"string","description":"Filters the results by the creator of the pipeline"},"Status":{"type":"string","description":"Filters the results by the current status of the pipeline. Valid values: `Init`: initializing `Running`: running `Success`: succeeded…"},"ObjectId":{"type":"string","description":"The ID of the artifact"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. The default value is 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-process-definitions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_process_definitions","summary":"Queries process definitions of a specified type","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Type":{"type":"string","description":"The type of the process definition. Valid values: MaxCompute DataService Extension Hologres EMR (You cannot create custom definitions for…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-project-members":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_project_members","summary":"Gets a paginated list of workspace member details","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. To obtain this ID, log in to the DataWorks Console (https://workbench.data.aliyun.com/console) and go…"},"UserIds":{"type":"string","description":"A list of DataWorks user IDs to filter the results. You can find these IDs on the Tenant Members and Roles…"},"RoleCodes":{"type":"string","description":"A list of role codes for the workspace to filter the results. You can call the https://help.aliyun.com/document_detail/2853930.html…"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-project-roles":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_project_roles","summary":"Queries the details of workspace roles by paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Codes":{"type":"string","description":"The list of workspace role codes (JSON-encoded)"},"Names":{"type":"string","description":"The list of workspace role names (JSON-encoded)"},"Type":{"type":"string","description":"The type of the workspace role. Valid values: UserCustom: Custom role. System: System role"},"PageNumber":{"type":"integer","description":"The page number of the requested data"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-projects":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_projects","summary":"Queries a list of DataWorks workspaces of the tenant to which your account belongs","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Ids":{"type":"string","description":"The IDs of the DataWorks workspaces (JSON-encoded)"},"Names":{"type":"string","description":"The names of the DataWorks workspaces (JSON-encoded)"},"AliyunResourceGroupId":{"type":"string","description":"The ID of the Alibaba Cloud resource group to which the workspaces belong. You can log on to the Resource Management console…"},"Status":{"type":"string","description":"The status of the workspaces. Valid values: Available (running normally), Initializing (initializing), InitFailed (initialization failed),…"},"DevEnvironmentEnabled":{"type":"string","description":"Specifies whether the development environment is enabled. Valid values: true: The development environment is enabled. In this case, the…"},"DevRoleDisabled":{"type":"string","description":"Specifies whether the developer role is disabled. Valid values: false (enabled, default) and true (disabled). This parameter filters…"},"PaiTaskEnabled":{"type":"string","description":"Specifies whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values: true: Scheduling of PAI tasks is enabled. In this…"},"AliyunResourceTags":{"type":"string","description":"The list of tags. This parameter queries workspaces that have any of the specified tag key-value pairs (JSON-encoded)"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-resource-group-associate-projects":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_resource_group_associate_projects","summary":"Query the list of workspaces with which a resource group is associated","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId"],"properties":{"ResourceGroupId":{"type":"string","description":"The ID of the serverless resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-resource-group-metric-data":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_resource_group_metric_data","summary":"Queries the metric data of a resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId","MetricName"],"properties":{"ResourceGroupId":{"type":"string","description":"The unique identifier for the general-purpose resource group"},"MetricName":{"type":"string","enum":["CUSpec","CUUsage","CUUtilization","SlotSpec","SlotUsage","SchedulerCUMaxSpec","SchedulerCUUsage","SchedulerCUMinSpec","DataIntegrationCUMaxSpec","DataIntegrationCUUsage","DataIntegrationCUMinSpec","DataServiceCUMaxSpec","DataServiceCUUsage","DataServiceCUMinSpec","ServerIdeCUMaxSpec","ServerIdeCUUsage","ServerIdeCUMinSpec"],"description":"The metric name. Valid values: CUSpec: Maximum CU capacity of the resource group, in CUs. CUUsage: CU usage of the resource group, in CUs.…"},"Period":{"type":"string","description":"The statistical period for monitoring data. Value: A multiple of 60. Unit: Seconds. Default: 60"},"BeginTime":{"type":"integer","description":"The start time. Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970). The…"},"EndTime":{"type":"integer","description":"The end time. Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970). The…"},"NextToken":{"type":"string","description":"The pagination cursor. If this parameter is not set, the first page of data is retrieved. If a value is returned for this parameter, it…"},"Length":{"type":"integer","description":"The number of records to display on each page for paginated queries. The maximum value of Length for a single request is 1440"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-resource-groups":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_resource_groups","summary":"Retrieves a list of resource groups","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"The name of the resource group for fuzzy match"},"ProjectId":{"type":"integer","description":"The ID of the workspace to which the resource group belongs"},"Statuses":{"type":"string","description":"The statuses of the resource groups to query (JSON-encoded)"},"ResourceGroupTypes":{"type":"string","description":"The types of the resource groups to query. If this parameter is left empty, general-purpose resource groups are queried by default…"},"PaymentType":{"type":"string","enum":["PrePaid","PostPaid"],"description":"The billing method of the resource group. Valid values: PrePaid: Subscription. PostPaid: Pay-as-you-go"},"AliyunResourceGroupId":{"type":"string","description":"The ID of the Alibaba Cloud resource group"},"AliyunResourceTags":{"type":"string","description":"The Alibaba Cloud tags (JSON-encoded)"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNumber":{"type":"integer","description":"The page number"},"SortBy":{"type":"string","description":"The fields by which to sort the results. You can sort the results by fields such as scheduled time and start time. The format is 'Sort…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-resources":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_resources","summary":"Retrieves a paginated list of resource files and filters resources","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Owner":{"type":"string","description":"The ID of the owner, which is the UID of the workspace administrator account. You can log on to the Alibaba Cloud Management Console and…"},"Type":{"type":"string","description":"The filter condition for the resource type. Valid values: Python Jar Archive File"},"Name":{"type":"string","description":"The name of the file resource. Fuzzy match is supported"},"PageNumber":{"type":"integer","description":"The number of the page to return"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-routes":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_routes","summary":"Retrieves the route list of a network resource","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId"],"properties":{"ResourceGroupId":{"type":"string","description":"The unique identifier of the general-purpose resource group"},"NetworkId":{"type":"integer","description":"The ID of the network resource"},"PageSize":{"type":"integer","description":"The number of entries per page"},"PageNumber":{"type":"integer","description":"The page number"},"SortBy":{"type":"string","description":"The list of sort fields. Fields such as scheduled time and start time are supported. The format is \"sort field + sort order (Desc/Asc)\"…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-schemas":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_schemas","summary":"Queries the list of schemas under a specified database or MaxCompute project in Data Map. Currently supports…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentMetaEntityId"],"properties":{"ParentMetaEntityId":{"type":"string","description":"The parent entity ID. For more information, see https://help.aliyun.com/document_detail/2880092.html. For the Hologres metadata crawler…"},"Name":{"type":"string","description":"The name. Fuzzy match is supported"},"Comment":{"type":"string","description":"The comment. Fuzzy match is supported"},"Types":{"type":"string","description":"The types. Exact match is supported. If this parameter is left empty, all types are queried (JSON-encoded)"},"SortBy":{"type":"string","enum":["CreateTime","ModifyTime","Name","Type"],"description":"The field used for sorting. Default value: CreateTime. Valid values: CreateTime ModifyTime Name Type"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The order in which schemas are sorted. Default value: Asc. Valid values: Asc: ascending order Desc: descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-security-strategies":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_security_strategies","summary":"Retrieves a paginated list of security policies in the system based on specified conditions. This operation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ControlModule":{"type":"string","enum":["DataQuery","DataStudio"],"description":"The control module"},"ControlSubModule":{"type":"string","enum":["MyCatalog"],"description":"The control submodule"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 20"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-semantic-job-runs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_semantic_job_runs","summary":"Queries the run records of a created node by Name with paging. The JobRunId in each record is active for…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["JobName"],"properties":{"JobName":{"type":"string","description":"The job name. Use the Data.Name value from the CreateSemanticJob response or the Name value from a ListSemanticJobs list item"},"PageNumber":{"type":"integer","description":"The page number, starting from 1. If this parameter is not specified or set to a value less than or equal to 0, page 1 is returned"},"PageSize":{"type":"integer","description":"The number of run records to return per page. If this parameter is not specified or set to a value less than or equal to 0, the default…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-semantic-jobs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_semantic_jobs","summary":"Queries the semantic node definitions of the current tenant with paging. The Name, ProjectId, and Source…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"PageNumber":{"type":"integer","description":"The page number, starting from 1. If this parameter is not specified or is set to a value less than or equal to 0, page 1 is returned"},"PageSize":{"type":"integer","description":"The number of job definitions per page. If this parameter is not specified or is set to a value less than or equal to 0, the default value…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-server-ide-ecs-specs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_server_ide_ecs_specs","summary":"Queries the list of available ECS instance types for personal development environments","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId"],"properties":{"ResourceGroupId":{"type":"string","description":"The DataWorks resource group identifier. You can specify the numeric ID of the resource group or the full identifier in the…"},"AcceleratorType":{"type":"string","description":"The accelerator type. Valid values: CPU: uses only CPU. GPU: uses GPU acceleration"},"MaxResults":{"type":"integer","description":"The maximum number of records to return in a single request"},"NextToken":{"type":"string","description":"The pagination token used to retrieve the next page of results. You do not need to specify this parameter for the first request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-server-ide-images":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_server_ide_images","summary":"Queries the list of available images for personal development environments by using paging","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"The image name filter condition. Supports fuzzy match"},"Labels":{"type":"string","description":"The image label filter condition. Separate multiple Key=Value conditions with commas"},"PageNumber":{"type":"integer","description":"The page number. The value starts from 1"},"PageSize":{"type":"integer","description":"The number of records per page"},"MaxResults":{"type":"integer","description":"The maximum number of records to return in a single request"},"NextToken":{"type":"string","description":"The pagination token used to continue a query. You do not need to specify this parameter for the first request"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-server-ide-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_server_ide_instances","summary":"Performs a paging query of personal development environment instances. When you invoke this operation, use…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"ResourceGroupId":{"type":"string","description":"The DataWorks resource group identifier. You can use the numeric ID of the resource group or the full identifier in the…"},"Keyword":{"type":"string","description":"The keyword used to match the instance ID or instance name"},"RelatedUserId":{"type":"string","description":"The account ID of the user that owns the instance"},"SubType":{"type":"string","description":"The instance subtype. Valid values: PERSONAL_DEV: personal development environment DATA_AGENT: Data Agent"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1"},"PageSize":{"type":"integer","description":"The number of entries to return on each page"},"MaxResults":{"type":"integer","description":"The maximum number of entries to return for a single request"},"NextToken":{"type":"string","description":"The pagination token used to continue the query. You do not need to specify this parameter for the first call"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-skills":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_skills","summary":"Performs a paging query to list skills under the current account","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MaxResults":{"type":"integer","description":"The maximum number of entries to return in this request"},"NextToken":{"type":"string","description":"The pagination token. Do not pass this parameter for the first query. For subsequent queries, pass the NextToken returned in the previous…"},"Q":{"type":"string","description":"The search keyword for fuzzy matching by skill name"},"Visibility":{"type":"string","description":"The visibility levels used to filter results. Multiple values can be specified (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-snapshots":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_snapshots","summary":"Retrieves a list of version snapshots","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Namespace","ObjectId","Type"],"properties":{"Namespace":{"type":"string","description":"The namespace (project space projectId or personal space baseId)"},"ObjectId":{"type":"string","description":"The unique ID of the object"},"Type":{"type":"string","description":"The snapshot type. Multiple values are supported. Valid values: Saved, Deployed, and UnDeployed"},"PageNumber":{"type":"integer","description":"The page number"},"PageSize":{"type":"integer","description":"The page size"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-tables":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_tables","summary":"Queries a list of data tables in DataWorks Data Map. For data source types that do not support the schema…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentMetaEntityId"],"properties":{"ParentMetaEntityId":{"type":"string","description":"The ID of the parent metadata entity. You can refer to the response of the ListDatabases or ListSchemas operation, or see…"},"Name":{"type":"string","description":"The name of the data table. Fuzzy match is supported"},"Comment":{"type":"string","description":"The comment on the data table. Fuzzy match is supported"},"TableTypes":{"type":"string","description":"The list of table types to query. If this parameter is left empty, all table types are queried (JSON-encoded)"},"SortBy":{"type":"string","enum":["CreateTime","ModifyTime","Name","TableType"],"description":"The field by which to sort the results. Default value: CreateTime. Valid values: CreateTime: creation time ModifyTime: modification time…"},"Order":{"type":"string","enum":["Asc","Desc"],"description":"The sort order. Default value: Asc. Valid values: Asc: ascending order Desc: descending order"},"PageNumber":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 100"},"IncludeExtendedProperties":{"type":"string","description":"Specifies whether to return extended properties. If this parameter is set to `true`, extended properties are returned. If this parameter…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-task-instance-operation-logs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_task_instance_operation_logs","summary":"Retrieves a paginated list of operation logs for a task instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The instance ID"},"Date":{"type":"integer","description":"The operation date, accurate to the day. The default value is the current day. You can query only the operation logs generated within the…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_task_instances","summary":"Retrieves a paged list of task instances. You can also perform a filtered query based on conditions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Bizdate"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"Bizdate":{"type":"integer","description":"The business date. Typically, this is 00:00:00 of the day before the scheduled time of the periodic instance, in the format of a…"},"TaskId":{"type":"integer","description":"The ID of the task"},"TaskIds":{"type":"string","description":"The task IDs. You can specify multiple task IDs to query task instances in batches (JSON-encoded)"},"TaskName":{"type":"string","description":"The task name. Fuzzy match is supported"},"Owner":{"type":"string","description":"The account ID of the task owner"},"TaskType":{"type":"string","description":"The task type. For the valid values of TaskType for each node, see https://help.aliyun.com/document_detail/600169.html"},"RuntimeResource":{"type":"string","description":"The resource group information. Specify the identifier of the scheduling resource group"},"WorkflowId":{"type":"integer","description":"The ID of the associated workflow"},"UnifiedWorkflowInstanceId":{"type":"integer","description":"The unified workflow instance ID. This value is the same for all task instances within a specific business date under a single trigger"},"WorkflowInstanceType":{"type":"string","enum":["Normal","ManualWorkflow","Manual","SupplementData","SmokeTest","TriggerWorkflow"],"description":"The type of the workflow instance. Valid values: SmokeTest: test Manual: manual task SupplementData: data backfill ManualWorkflow: manual…"},"WorkflowInstanceId":{"type":"integer","description":"The ID of the associated workflow instance"},"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production Dev: development"},"Id":{"type":"integer","description":"The task instance ID. A task instance may be rerun. If you specify this parameter, the response includes historical rerun records, which…"},"Ids":{"type":"string","description":"The task instance IDs. You can specify multiple task instance IDs to query task instances in batches (JSON-encoded)"},"TriggerType":{"type":"string","enum":["Scheduler","Manual"],"description":"The trigger type. Valid values: Scheduler: periodic scheduling Manual: manual"},"TriggerRecurrence":{"type":"string","enum":["Normal","Skip","Pause"],"description":"The run mode upon triggering. This parameter takes effect only when TriggerType is set to Scheduler. Valid values: Pause: pause Skip: dry…"},"SortBy":{"type":"string","description":"The sort field. Fields such as scheduled time and start time are supported. The format is 'Sort field + Sort order (Desc/Asc)', where Asc…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10. Maximum value: 500"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"Status":{"type":"string","enum":["NotRun","Running","Failure","Success","WaitTime","WaitResource"],"description":"The status of the task instance. Valid values: `NotRun`: not run `Running`: running `Failure`: failed `Success`: successful `WaitTime`:…"},"Filter":{"type":"string","description":"The filter conditions in JSON format. Multiple filter conditions are combined with the AND logical operator. Supported fields:…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-task-operation-logs":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_task_operation_logs","summary":"Queries a paginated list of operation logs for a specified task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The task ID"},"Date":{"type":"integer","description":"The operation date, accurate to the day. Default value: the current day. Only operation logs from the past 31 days can be queried. The…"},"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production. Dev: development"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-tasks":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_tasks","summary":"Queries a list of tasks by page. You can also specify filter conditions to query tasks","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The workspace environment. Valid values: Prod Dev"},"ProjectId":{"type":"integer","description":"The workspace ID"},"Name":{"type":"string","description":"The name of the task. Fuzzy match is supported"},"Ids":{"type":"string","description":"The ID of the task (JSON-encoded)"},"Owner":{"type":"string","description":"The account ID of the task owner"},"TaskType":{"type":"string","description":"The type of the task. Valid values: ODPS_SQL SPARK PY_ODPS PY_ODPS3 ODPS_SCRIPT ODPS_MR COMPONENT_SQL EMR_HIVE EMR_MR EMR_SPARK_SQL…"},"RuntimeResource":{"type":"string","description":"The information about the resource group. Set this parameter to the ID of a resource group for scheduling"},"WorkflowId":{"type":"integer","description":"The ID of the workflow to which the task belongs"},"TriggerType":{"type":"string","enum":["Scheduler","Manual"],"description":"The trigger type. Valid values: Scheduler: Triggered by schedule. Manual: Triggered manually"},"TriggerRecurrence":{"type":"string","enum":["Normal","Skip","Pause"],"description":"The run mode when triggered. Valid only if TriggerType is Scheduler. Valid values: Pause Skip Normal"},"SortBy":{"type":"string","description":"The field that is used to sort tasks. This parameter is configured in the format of \"Sorting field Sorting order\". You can set the sorting…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-upstream-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_upstream_task_instances","summary":"Retrieves the upstream instances of a specified instance by page","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The instance ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-upstream-tasks":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_upstream_tasks","summary":"Queries a list of ancestor tasks of a task by page","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"ProjectEnv":{"type":"string","enum":["Prod","Dev"],"description":"The environment of the workspace. Valid values: Prod: production environment Dev: development environment"},"Id":{"type":"integer","description":"The task ID"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from page 1. Default value: 1"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-workflow-definitions":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_workflow_definitions","summary":"Queries a paginated list of data development workflows. You can also filter workflows based on specified…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Type":{"type":"string","description":"The type of the workflow. This parameter is used as a filter condition. If you do not specify this parameter, the default value is…"},"Owner":{"type":"string","description":"The ID of the owner, which is the UID of the workspace administrator account. You can log on to the Alibaba Cloud Management Console and…"},"Name":{"type":"string","description":"The name of the workflow. Fuzzy search is supported"},"PageNumber":{"type":"integer","description":"The number of the page to return"},"PageSize":{"type":"integer","description":"The number of entries to return on each page. Default value: 10. Maximum value: 100"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-workflow-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_workflow_instances","summary":"Retrieves a list of workflow instances by using paging. You can also perform a filtered query based on…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","BizDate"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"BizDate":{"type":"integer","description":"The business date. Typically, this is 00:00:00 on the day before the scheduled time of the periodic instance, formatted as a millisecond…"},"Type":{"type":"string","enum":["Normal","ManualWorkflow","Manual","SupplementData","SmokeTest","TriggerWorkflow"],"description":"The type of the workflow instance. Valid values: Normal: Periodic scheduling. Manual: Manual task. SmokeTest: Smoke test. SupplementData:…"},"WorkflowId":{"type":"integer","description":"The ID of the workflow to which the instance belongs"},"UnifiedWorkflowInstanceId":{"type":"integer","description":"The unified workflow instance ID. The value of this field is the same for all workflow instances within a specific business date under a…"},"Name":{"type":"string","description":"The name. Fuzzy match is supported"},"Ids":{"type":"string","description":"The list of workflow instance IDs. You can use this parameter to query multiple workflow instances in batches by their IDs (JSON-encoded)"},"Owner":{"type":"string","description":"The account ID of the owner"},"SortBy":{"type":"string","description":"The list of sort fields. Fields such as the scheduled time and start time are supported. The format is \"Sort field + Sort order…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"Tags":{"type":"string","description":"The list of tags. If an instance matches any of the specified tags, it is returned in the result (JSON-encoded)"},"Filter":{"type":"string","description":"The filter. The value is in JSON format. Multiple filter conditions are connected by the logical AND operator. Supported fields: `status`…"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: Production. Dev: Development"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/list-workflows":{"post":{"operationId":"cloud_aliyun_dataworks_public_list_workflows","summary":"Retrieves a list of workflows with paging, and supports filtered query by conditions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment"},"Ids":{"type":"string","description":"The list of workflow IDs. You can specify multiple workflow IDs to query multiple workflows at a time (JSON-encoded)"},"Name":{"type":"string","description":"The name. Fuzzy match is supported"},"Owner":{"type":"string","description":"The account ID of the owner"},"TriggerType":{"type":"string","enum":["Scheduler","Manual","TriggerWorkflow"],"description":"The trigger type. Valid values: Scheduler Manual TriggerWorkflow"},"SortBy":{"type":"string","description":"The sort field. You can sort by fields such as modification time and creation time. The format is 'SortField+SortOrder(Desc/Asc)', where…"},"PageSize":{"type":"integer","description":"The number of entries per page. Default value: 10"},"PageNumber":{"type":"integer","description":"The page number. Pages start from 1. Default value: 1"},"Tags":{"type":"string","description":"The list of tags. If a workflow matches any of the specified tags, it is returned in the result (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/load-agent-session":{"post":{"operationId":"cloud_aliyun_dataworks_public_load_agent_session","summary":"Loads the historical messages of an existing session and returns them in a Server-Sent Events (SSE) stream.…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. Fixed to 2.0"},"Id":{"type":"string","description":"The ID provided by the requester. This ID is echoed back as is"},"Params":{"type":"string","description":"The business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/move-function":{"post":{"operationId":"cloud_aliyun_dataworks_public_move_function","summary":"Moves a user-defined function (UDF) to a path in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Path"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The unique identifier of the UDF. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions…"},"Path":{"type":"string","description":"The destination path, without the function name. For example, to move the `test` function to `root/demo/test`, set this parameter to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/move-node":{"post":{"operationId":"cloud_aliyun_dataworks_public_move_node","summary":"Moves a node to a path in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Path"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio node. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in…"},"Path":{"type":"string","description":"The destination path to which you want to move the node. Do not include the node name. For example, to move the test node to…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/move-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_move_resource","summary":"Moves a specified Data Studio file resource to a specified Data Studio folder","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Path"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio file resource. Before SDK version 8.0.0, this field is of the Long type. In SDK version 8.0.0 and…"},"Path":{"type":"string","description":"The destination path for the move operation. Do not include the file resource name in the path. For example, to change the path of the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/move-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_move_workflow_definition","summary":"Moves a workflow to a path in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Path"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio workflow. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type…"},"Path":{"type":"string","description":"The path to which you want to move the workflow. You do not need to specify a workflow name in the path. For example, if you want to move…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/preview-dataset-version":{"post":{"operationId":"cloud_aliyun_dataworks_public_preview_dataset_version","summary":"Previews the content of a specified dataset version. Currently only text file preview is supported for…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset version ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/prompt-agent-session":{"post":{"operationId":"cloud_aliyun_dataworks_public_prompt_agent_session","summary":"Sends a user prompt to an existing session and returns the Agent response in streaming mode","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC version. Fixed value: 2.0"},"Id":{"type":"string","description":"The ID passed by the requester. The value is returned as-is"},"Params":{"type":"string","description":"The business parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/publish-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_publish_image","summary":"Publishes an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"},"ProcessId":{"type":"string","description":"The image publish execution ID, which is used as an idempotence identifier"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/remove-entity-from-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_remove_entity_from_meta_collection","summary":"Remove an entity object from a Data Map collection. The collection supports Data Map categories and data…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MetaCollectionId":{"type":"string","description":"The collection ID. You can call the ListMetaCollections operation to query the ID"},"Id":{"type":"string","description":"The entity ID. Currently, entities can only be tables. You can call the ListTables operation to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/remove-task-instance-dependencies":{"post":{"operationId":"cloud_aliyun_dataworks_public_remove_task_instance_dependencies","summary":"Removes multiple upstream dependencies of an instance at a time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The instance ID"},"UpstreamTaskInstanceIds":{"type":"string","description":"The IDs of ancestor instances of the instance (JSON-encoded)"},"Comment":{"type":"string","description":"The remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rename-function":{"post":{"operationId":"cloud_aliyun_dataworks_public_rename_function","summary":"Renames a user-defined function (UDF) in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Name"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio UDF. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK…"},"Name":{"type":"string","description":"The new name of the function"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rename-node":{"post":{"operationId":"cloud_aliyun_dataworks_public_rename_node","summary":"Renames a node in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Name"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio node. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in…"},"Name":{"type":"string","description":"The new name for the node"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rename-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_rename_resource","summary":"Renames a file resource in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Name"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio file resource. This field is of the Long type in SDK versions prior to 8.0.0, and of the String…"},"Name":{"type":"string","description":"The new name of the file resource"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rename-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_rename_workflow_definition","summary":"Renames a workflow in Data Studio","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Name"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio workflow. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type…"},"Name":{"type":"string","description":"The new name of the workflow"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/reply-agent-session":{"post":{"operationId":"cloud_aliyun_dataworks_public_reply_agent_session","summary":"Replies to a pending user interaction in a DataAgent session","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","Params"],"properties":{"Jsonrpc":{"type":"string","enum":["2.0"],"description":"The JSON-RPC protocol version. Fixed to 2.0"},"Id":{"type":"string","description":"The JSON-RPC correlation ID for the current reply request. It is returned as-is in the response and is different from PermissionRequestId"},"Params":{"type":"string","description":"The user interaction reply parameters (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rerun-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_rerun_task_instances","summary":"Reruns multiple node instances in a batch","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Ids":{"type":"string","description":"The list of node instance IDs (JSON-encoded)"},"Comment":{"type":"string","description":"The remarks"},"UseLatestConfig":{"type":"string","description":"Specifies whether to rerun instances with the latest configuration"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rerun-workflow-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_rerun_workflow_instances","summary":"Reruns a workflow instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","WorkflowId","Type"],"properties":{"ProjectId":{"type":"integer","description":"The project ID"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: Production. Dev: Development"},"WorkflowId":{"type":"integer","description":"The ID of the workflow"},"Type":{"type":"string","enum":["ManualWorkflow"],"description":"The type of the workflow instance. Valid values: ManualWorkflow: Manual workflow"},"Name":{"type":"string","description":"The name of the manual workflow used for fuzzy matching"},"StartTriggerTime":{"type":"integer","description":"The start trigger time (creation time) of the manual workflow instance used for matching. This parameter must be used together with…"},"EndTriggerTime":{"type":"integer","description":"The end trigger time (creation time) of the manual workflow instance used for matching. This parameter must be used together with…"},"Bizdate":{"type":"integer","description":"The data timestamp specified for the manual workflow instance run, used for matching. The value is a 13-digit number, such as…"},"Status":{"type":"string","enum":["Success","Failure"],"description":"The running status of the manual workflow instance used for matching"},"Ids":{"type":"string","description":"The list of manual workflow instance IDs used for matching (JSON-encoded)"},"Filter":{"type":"string","description":"The matching conditions for the internal instances of the manual workflow instance (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/resume-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_resume_task_instances","summary":"Resumes multiple suspended instances at a time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Ids":{"type":"string","description":"The ID list of the task instance (JSON-encoded)"},"Comment":{"type":"string","description":"Remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/revoke-member-project-roles":{"post":{"operationId":"cloud_aliyun_dataworks_public_revoke_member_project_roles","summary":"Revokes roles from a workspace member","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","UserId","RoleCodes"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to…"},"UserId":{"type":"string","description":"The ID of the DataWorks account. You can log on to the DataWorks console - Management Center…"},"RoleCodes":{"type":"string","description":"The list of workspace role codes. You can call https://help.aliyun.com/document_detail/2853930.html to obtain the role codes. This…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rollback-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_rollback_image","summary":"Rolls back an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ImageVersion"],"properties":{"Id":{"type":"string","description":"The image ID"},"ImageVersion":{"type":"string","description":"The image version to roll back"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/rollback-parameter":{"post":{"operationId":"cloud_aliyun_dataworks_public_rollback_parameter","summary":"Rolls back a specified parameter","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","RollbackVersion"],"properties":{"Id":{"type":"integer","description":"The parameter ID"},"RollbackVersion":{"type":"integer","description":"The rollback version"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/run-crawler":{"post":{"operationId":"cloud_aliyun_dataworks_public_run_crawler","summary":"Triggers a specified metadata crawler to run and returns the acceptance status and associated task instance…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the metadata crawler. You can call ListCrawlers to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/run-image-test":{"post":{"operationId":"cloud_aliyun_dataworks_public_run_image_test","summary":"Runs an image test","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ResourceGroupId"],"properties":{"Id":{"type":"string","description":"The image ID"},"ResourceGroupId":{"type":"string","description":"The unique identifier of the general-purpose resource group used to run the test task. Only Serverless resource groups are supported"},"ProcessId":{"type":"string","description":"The image test execution ID, which is used as an idempotence identifier"},"Cu":{"type":"number","description":"The test compute unit (CU)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/run-semantic-job":{"post":{"operationId":"cloud_aliyun_dataworks_public_run_semantic_job","summary":"Submits a saved semantic job for execution by name and returns the run and executor identifiers. A…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the job to run. Use the Data.Name value from the CreateSemanticJob response or the Name value from a ListSemanticJobs list…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/set-success-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_set_success_task_instances","summary":"Sets the statuses of multiple instances to successful at a time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Ids":{"type":"string","description":"The ID list of the task instance (JSON-encoded)"},"Comment":{"type":"string","description":"Remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/start-dijob":{"post":{"operationId":"cloud_aliyun_dataworks_public_start_dijob","summary":"Starts a new-version synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The instance ID"},"ForceToRerun":{"type":"string","description":"Specifies whether to forcefully rerun all synchronization steps. If you do not configure this parameter, the system does not perform the…"},"RealtimeStartSettings":{"type":"string","description":"The settings for starting real-time synchronization. ``` { \"StartTime\":1663765058 } ``` (JSON-encoded)"},"DIJobId":{"type":"integer","description":"This parameter is deprecated. Use the Id parameter instead"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/start-server-ide-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_start_server_ide_instance","summary":"Starts a specified personal development environment instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the personal development environment instance. You can call ListServerIdeInstances to obtain the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/start-workflow-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_start_workflow_instances","summary":"Starts multiple workflow instances in a batch","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Ids"],"properties":{"Ids":{"type":"string","description":"The list of workflow instance IDs (JSON-encoded)"},"Comment":{"type":"string","description":"The remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/stop-crawler":{"post":{"operationId":"cloud_aliyun_dataworks_public_stop_crawler","summary":"Stops the currently running task of a specified metadata crawler","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the metadata crawler. You can call ListCrawlers to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/stop-dijob":{"post":{"operationId":"cloud_aliyun_dataworks_public_stop_dijob","summary":"Aborts a data integration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the sync task"},"InstanceId":{"type":"integer","description":"The ID of the instance"},"DIJobId":{"type":"integer","description":"[Deprecated] This parameter is deprecated. Use the Id parameter instead"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/stop-process-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_stop_process_instance","summary":"Withdraws or terminates a specified process instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProcessInstanceId"],"properties":{"ProcessInstanceId":{"type":"string","description":"The process instance ID. This operation supports approval forms from both the old and new versions of Security Center"},"ClientToken":{"type":"string","description":"A token to ensure that the request is idempotent. We recommend that you use a universally unique identifier (UUID)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/stop-server-ide-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_stop_server_ide_instance","summary":"Stops a specified personal development environment instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The ID of the personal development environment instance. You can call ListServerIdeInstances to obtain the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/stop-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_stop_task_instances","summary":"Stops multiple task instances","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Ids":{"type":"string","description":"The list of task instance IDs (JSON-encoded)"},"Comment":{"type":"string","description":"The comment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/stop-workflow-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_stop_workflow_instances","summary":"Terminates multiple workflow instances in batches","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Ids"],"properties":{"Ids":{"type":"string","description":"The list of workflow instance IDs. You can call the ListWorkflowInstances operation to query workflow instance IDs (JSON-encoded)"},"Comment":{"type":"string","description":"The comment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/submit-batch-change-table-owner":{"post":{"operationId":"cloud_aliyun_dataworks_public_submit_batch_change_table_owner","summary":"Submits a batch request to transfer table ownership","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Owner","TableMetaEntityIds"],"properties":{"Owner":{"type":"string","description":"The target owner after the transfer. Use the Alibaba Cloud UID"},"TableMetaEntityIds":{"type":"string","description":"The list of MaxCompute table metadata entity IDs to transfer. A maximum of 100 tables are allowed per request. Duplicate values are not…"},"EnableCrossTenant":{"type":"string","description":"Specifies whether to allow transferring ownership to an owner in a different tenant. Default value: false"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/submit-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_submit_file","summary":"Commits a file to the development environment of the scheduling system to generate a task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to query the…"},"FileId":{"type":"integer","description":"The file ID. You can call the https://help.aliyun.com/document_detail/173942.html operation to obtain the ID"},"Comment":{"type":"string","description":"The description of the submission"},"SkipAllDeployFileExtensions":{"type":"string","description":"Whether to skip the pre-deployment check after the file is submitted: false: Do not skip. After the file is submitted, the system…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/suspend-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_suspend_task_instances","summary":"Suspends multiple instances at a time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Ids":{"type":"string","description":"The ID list of the task instance (JSON-encoded)"},"Comment":{"type":"string","description":"Remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/tag-data-assets":{"post":{"operationId":"cloud_aliyun_dataworks_public_tag_data_assets","summary":"Attaches tags to data assets","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Tags","DataAssetIds","DataAssetType"],"properties":{"Tags":{"type":"string","description":"The list of data asset tags to attach (JSON-encoded)"},"DataAssetIds":{"type":"string","description":"The list of unique IDs of the data assets. You can call the ListDataAssets operation to query the IDs of data assets to which tags can be…"},"DataAssetType":{"type":"string","enum":["ACS::DataWorks::Task","ACS::DataWorks::Table"],"description":"The data asset type. Valid values: DataWorks table (ACS::DataWorks::Table) DataWorks scheduled task (ACS::DataWorks::Task)"},"ProjectId":{"type":"integer","description":"The ID of the workspace"},"EnvType":{"type":"string","enum":["Dev","Prod"],"description":"The workspace environment to which the data asset belongs. Valid values: Dev (development environment) Prod (production environment)"},"AutoTraceEnabled":{"type":"string","description":"Specifies whether to enable automatic data lineage backtracking"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/test-data-source-connectivity":{"post":{"operationId":"cloud_aliyun_dataworks_public_test_data_source_connectivity","summary":"Test the connectivity of a data source on a resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceGroupId","DataSourceId","ProjectId"],"properties":{"ResourceGroupId":{"type":"string","description":"The resource group ID"},"DataSourceId":{"type":"integer","description":"The ID of the data source for which you want to test the network connectivity"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/trigger-scheduler-task-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_trigger_scheduler_task_instance","summary":"Triggers a task to run by using an HTTP Trigger node at a specified time","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["TaskId","TriggerTime"],"properties":{"TaskId":{"type":"integer","description":"The task ID"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The environment of the workspace. Valid values: Prod: production environment Dev: development environment"},"TriggerTime":{"type":"integer","description":"The time defined by the HTTP Trigger node. This value is a UNIX timestamp"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/un-tag-data-assets":{"post":{"operationId":"cloud_aliyun_dataworks_public_un_tag_data_assets","summary":"Disassociates tags from data assets","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Tags","DataAssetIds","DataAssetType"],"properties":{"Tags":{"type":"string","description":"The tags to disassociate (JSON-encoded)"},"DataAssetIds":{"type":"string","description":"The unique IDs of the data assets (JSON-encoded)"},"DataAssetType":{"type":"string","enum":["ACS::DataWorks::Task","ACS::DataWorks::Table"],"description":"The type of the data asset. Valid values: Data table (ACS::DataWorks::Table) Scheduled task (ACS::DataWorks::Task)"},"ProjectId":{"type":"integer","description":"The ID of the workspace"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The workspace environment to which the data asset belongs. Valid values: Dev: development environment Prod: production environment"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-agent-session-title":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_agent_session_title","summary":"Modifies the title of an agent session accessible to the current identity without changing the task…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Jsonrpc":{"type":"string","description":"The JSON-RPC protocol version. Valid value: 2.0"},"Id":{"type":"string","description":"The JSON-RPC correlation ID for the current request. It is specified by the caller and used to correlate the request and response"},"Params":{"type":"string","description":"The request parameters for modifying the session title, including the target session ID and the new title (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_alert_rule","summary":"Updates the information about a custom alert monitoring rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The rule ID"},"Name":{"type":"string","description":"The name of the rule"},"Owner":{"type":"string","description":"The ID of the Alibaba Cloud account used by the owner of the rule"},"Enabled":{"type":"string","description":"Specifies whether to enable the rule"},"TriggerCondition":{"type":"string","description":"The alert triggering condition (JSON-encoded)"},"Notification":{"type":"string","description":"The configuration for the alert notification (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-business":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_business","summary":"Updates a workflow","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BusinessId"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to the…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go…"},"BusinessName":{"type":"string","description":"The name of the workflow. You can call the https://help.aliyun.com/document_detail/173945.html operation to query the name"},"Description":{"type":"string","description":"The description of the workflow"},"Owner":{"type":"string","description":"The owner of the workflow. You can call the https://help.aliyun.com/document_detail/173945.html operation to query the owner"},"BusinessId":{"type":"integer","description":"The workflow ID. You can call the https://help.aliyun.com/document_detail/173945.html operation to query the ID"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-calendar":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_calendar","summary":"Updates a scheduling calendar. This is a full update that requires you to submit the complete editable…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","Type","SchedulePolicy","Owner","Description"],"properties":{"Id":{"type":"integer","description":"The ID of the scheduling calendar"},"AllProjects":{"type":"string","description":"Specifies whether the calendar applies to all workspaces. Default value: false. Valid values: true: All workspaces. false: The workspaces…"},"ProjectIds":{"type":"string","description":"The list of applicable workspace IDs. Required and cannot be empty when AllProjects is set to false or left unspecified. Leave empty or…"},"Type":{"type":"string","enum":["StrongConstraint","WeakConstraint"],"description":"The calendar type. Valid values: StrongConstraint: Strong constraint calendar. WeakConstraint: Weak constraint calendar"},"StartDate":{"type":"string","description":"The start date of the calendar validity period, in the `yyyy-mm-dd` format. Required when Type is set to StrongConstraint"},"EndDate":{"type":"string","description":"The end date of the calendar validity period, in the `yyyy-mm-dd` format. Required when Type is set to StrongConstraint. The end date…"},"ExpirationReminder":{"type":"string","enum":["OneMonthBefore","OneWeekBefore","ThreeDaysBefore"],"description":"The expiration reminder. Required when Type is set to StrongConstraint. Valid values: OneMonthBefore: One month in advance. OneWeekBefore:…"},"OverduePolicy":{"type":"string","enum":["Normal","Pause","Skip"],"description":"The scheduling policy after the calendar expires. Required when Type is set to StrongConstraint. Valid values: Normal: Normal scheduling.…"},"SchedulePolicy":{"type":"string","description":"The date scheduling policy. For a strong constraint calendar, the normal scheduling dates and non-scheduling dates must cover every day…"},"FallbackPolicy":{"type":"string","enum":["Normal","Pause","Skip"],"description":"The default scheduling policy for dates that are not configured. Required when Type is set to WeakConstraint. Valid values: Normal: Normal…"},"Owner":{"type":"string","description":"The account ID of the owner"},"Description":{"type":"string","description":"The description of the scheduling calendar. The description must be 5 to 2,048 characters in length"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-column-business-metadata":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_column_business_metadata","summary":"Updates the business metadata for a column in a data map. This operation can only update the business…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the column. You can obtain this ID from the response of the `ListColumns` operation. For more information, see…"},"Description":{"type":"string","description":"The business description of the column"},"CustomAttributes":{"type":"string","description":"The custom attributes of the column, specified as key-value pairs. The key is the attribute identifier, and the value is an array that can…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-component":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_component","summary":"Updates components","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ComponentId","Spec","ProjectId"],"properties":{"ComponentId":{"type":"string","description":"The component ID"},"Spec":{"type":"string","description":"The FlowSpec information for this UDF function. For more information, see FlowSpec…"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-compute-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_compute_resource","summary":"Modifies a specified compute resource based on the compute resource ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId","ConnectionProperties"],"properties":{"Id":{"type":"integer","description":"The compute resource ID"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"ConnectionPropertiesMode":{"type":"string","enum":["UrlMode","InstanceMode","CdhMode"],"description":"The category of the added compute resource. Different types have different subtypes, which correspond to different parameter schema…"},"Description":{"type":"string","description":"The description of the compute resource. The description can be up to 3,000 characters in length"},"ConnectionProperties":{"type":"string","description":"The specific connection configuration information of the compute resource, including the endpoint, access identity, and environment…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-compute-resource-auth-user-mappings":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_compute_resource_auth_user_mappings","summary":"Updates the account mapping of a compute resource. Currently supports EMR and Serverless Spark resource types","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ComputeResourceId","ProjectId"],"properties":{"ComputeResourceId":{"type":"integer","description":"The compute resource ID"},"ProjectId":{"type":"integer","description":"The workspace ID"},"Upserts":{"type":"string","description":"The list of objects to update (JSON-encoded)"},"RemoveUserIds":{"type":"string","description":"The list of user mappings to remove (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-crawler":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_crawler","summary":"Updates the resource group, collection scope, scheduling, and extension configurations of a specified…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the metadata crawler. You can call ListCrawlers to query crawler IDs"},"ResourceGroupId":{"type":"string","description":"The ID of the Serverless 2.0 resource group used to run the collection task. Whether this parameter is supported and whether it is…"},"Scope":{"type":"string","description":"The collection scope configuration. If this parameter is specified, the collection scope is updated. If this parameter is not specified,…"},"ScheduleConfig":{"type":"string","description":"The scheduling configuration. If this parameter is specified, the scheduling method is updated. If this parameter is not specified, the…"},"EnableAiComment":{"type":"string","description":"Specifies whether to enable AI metadata description. This parameter is supported only when SupportAiComment returned by…"},"Options":{"type":"string","description":"The extension configurations for the crawler type. Only the specified configuration items are updated. Unspecified configuration items…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-custom-attribute":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_custom_attribute","summary":"Updates a custom attribute","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The custom attribute ID"},"DisplayName":{"type":"string","description":"The new display name for the custom attribute. It must be less than 128 characters"},"EntityTypes":{"type":"string","description":"The applicable entity types. This parameter supports specific types and wildcard formats, such as `*-table` and `*-column`. For example:…"},"ValueEnums":{"type":"string","description":"The enumerated values. This applies only to custom attributes of the `enum` type. You can only append new values during an update…"},"DisplayEnabled":{"type":"string","description":"Whether to display the custom attribute in the UI"},"SearchFilterEnabled":{"type":"string","description":"Whether the custom attribute can be used as a filter condition"},"Comment":{"type":"string","description":"The new description for the custom attribute. It must be less than 256 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-dialarm-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_dialarm_rule","summary":"Updates an alert rule configured for a synchronization task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The alert rule Id"},"Description":{"type":"string","description":"The description of the alert rule"},"MetricType":{"type":"string","description":"The metric type in the alert rule. Valid values: Heartbeat: task status alert FailoverCount: failover count alert Delay: task latency…"},"Enabled":{"type":"string","description":"Specifies whether to enable the alert rule. By default, the alert rule is disabled"},"DIJobId":{"type":"integer","description":"The ID of the synchronization task"},"TriggerConditions":{"type":"string","description":"The conditions that can trigger the alert rule (JSON-encoded)"},"NotificationSettings":{"type":"string","description":"The alert notification settings (JSON-encoded)"},"Name":{"type":"string","description":"The name of the alert rule"},"DIAlarmRuleId":{"type":"integer","description":"This parameter is deprecated. Use the Id parameter instead"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-dijob":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_dijob","summary":"Update a Data Integration task","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the synchronization job"},"Description":{"type":"string","description":"The description of the synchronization job"},"TableMappings":{"type":"string","description":"A list of object transformation mappings. Each mapping specifies a set of selection rules for source objects and a list of transformation…"},"JobSettings":{"type":"string","description":"The settings for the synchronization job. This includes DDL handling settings, data type mappings for columns between the source and…"},"ResourceSettings":{"type":"string","description":"The resource settings (JSON-encoded)"},"TransformationRules":{"type":"string","description":"A list of transformation rule definitions. [ { \"RuleName\":\"my_database_rename\\rule\", \"RuleActionType\":\"Rename\", \"RuleTargetType\":\"Schema\",…"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can call the https://help.aliyun.com/document_detail/178393.html operation to get the workspace ID"},"DIJobId":{"type":"integer","description":"This parameter is deprecated. Use the `Id` parameter instead"},"Owner":{"type":"string","description":"The owner of the synchronization job"},"FileSpec":{"type":"string","description":"The job configuration in script mode"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-data-asset-tag":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_data_asset_tag","summary":"Updates a label","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Key"],"properties":{"Key":{"type":"string","description":"The label key"},"Values":{"type":"string","description":"The list of label values (JSON-encoded)"},"Description":{"type":"string","description":"The label description"},"Managers":{"type":"string","description":"The list of label administrators (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-data-quality-alert-rule":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_data_quality_alert_rule","summary":"Updates a specified data quality monitoring alert rule","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"integer","description":"The ID of the alert rule"},"ProjectId":{"type":"integer","description":"The ID of the project"},"Condition":{"type":"string","description":"The alert condition of the data quality monitoring alert rule"},"Target":{"type":"string","description":"The target of the data quality monitoring alert rule (JSON-encoded)"},"Notification":{"type":"string","description":"The alert notification configuration (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-data-quality-scan":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_data_quality_scan","summary":"Updates a data quality monitor","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Description":{"type":"string","description":"Description of the data quality monitor"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace where the data quality monitor resides. You can obtain the workspace ID by calling the…"},"Id":{"type":"integer","description":"The ID of the data quality monitor"},"Owner":{"type":"string","description":"The user ID of the owner of the data quality monitor"},"Spec":{"type":"string","description":"The Spec code of the data quality monitoring content. For more information, see https://help.aliyun.com/document_detail/2963394.html"},"Parameters":{"type":"string","description":"The definition of execution parameters for the data quality monitor (JSON-encoded)"},"RuntimeResource":{"type":"string","description":"The resource group used during the execution of the data quality monitor (JSON-encoded)"},"ComputeResource":{"type":"string","description":"The compute engine used during execution. If it's not specified, the data source connection defined in the Spec will be used (JSON-encoded)"},"Trigger":{"type":"string","description":"Trigger settings for the data quality monitor (JSON-encoded)"},"Hooks":{"type":"string","description":"The hook configuration after the data quality monitor stops (JSON-encoded)"},"Name":{"type":"string","description":"The name of the data quality monitor"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-data-quality-template":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_data_quality_template","summary":"Updates a data quality rule template in a project","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"The ID of the custom rule template"},"ProjectId":{"type":"integer","description":"The project ID"},"Spec":{"type":"string","description":"Detailed configuration Spec code of the rule template. For more information, see [Data quality Spec configuration description](~2963394~)"},"Owner":{"type":"string","description":"The account ID of the owner"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-data-source":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_data_source","summary":"Modifies a specified data source based on the data source ID","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","ProjectId","ConnectionProperties"],"properties":{"Id":{"type":"integer","description":"The unique identifier of the data source"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace"},"ConnectionPropertiesMode":{"type":"string","enum":["UrlMode","InstanceMode","CdhMode"],"description":"The category used to add the data source. Different types have different subtypes and corresponding parameter constraints. Examples:…"},"Description":{"type":"string","description":"The description of the data source. The description can be up to 3,000 characters in length"},"ConnectionProperties":{"type":"string","description":"The specific connection configuration of the data source, including the endpoint, access identity, and environment context. The EnvType…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-dataset":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_dataset","summary":"Updates dataset information. Only DataWorks datasets are supported. The operator must be the creator of the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset ID. Only DataWorks datasets are supported for update"},"Name":{"type":"string","description":"The dataset name. A non-empty string, length not exceeding 128"},"Comment":{"type":"string","description":"The dataset description. Length not exceeding 1024"},"Readme":{"type":"string","description":"The user guide, supports Markdown formatted rich text"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-dataset-version":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_dataset_version","summary":"Updates dataset version information. Only DataWorks datasets are supported. Requires dataset creator or…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The dataset version ID. Only DataWorks datasets can be updated"},"Comment":{"type":"string","description":"The dataset version description. Maximum length: 1024 characters"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_file","summary":"Updates an existing file","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileId"],"properties":{"FileFolderPath":{"type":"string","description":"The path where the file is stored"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can logon to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"FileName":{"type":"string","description":"The name of the file. You can change the file name by resetting the value of FileName. For example, you can call the…"},"FileDescription":{"type":"string","description":"The description of the file"},"Content":{"type":"string","description":"The code content of the file. The code format varies based on the file type. You can go to Operation Center, right-click a task of the…"},"AutoRerunTimes":{"type":"integer","description":"The number of automatic reruns allowed after an error occurs"},"AutoRerunIntervalMillis":{"type":"integer","description":"The interval between automatic reruns after a failure, in milliseconds. The maximum value is 1800000, which indicates 30 minutes. This…"},"RerunMode":{"type":"string","enum":["ALL_ALLOWD","FAILURE_ALLOWED","ALL_DENIED","ALL_ALLOWED"],"description":"The rerun mode. Valid values: ALL_ALLOWED: The task can be rerun regardless of whether it is successfully run or fails to run.…"},"Stop":{"type":"string","description":"Specifies whether to pause scheduling. Valid values: true: Pause scheduling. false: Do not pause scheduling. This parameter corresponds to…"},"ParaValue":{"type":"string","description":"The scheduling parameters. This parameter corresponds to the Scheduling Parameters section in the Schedule section of the DataWorks…"},"StartEffectDate":{"type":"integer","description":"The start time of automatic scheduling, in the form of a millisecond timestamp. This parameter corresponds to the start time in the…"},"EndEffectDate":{"type":"integer","description":"The end time of automatic scheduling, in the form of a millisecond timestamp. This parameter corresponds to the end time in the Schedule >…"},"CronExpress":{"type":"string","description":"The cron expression for periodic scheduling. This parameter corresponds to the cron expression in the Schedule > Time Property section for…"},"CycleType":{"type":"string","enum":["DAY","NOT_DAY"],"description":"The type of the scheduling cycle. Valid values: NOT_DAY (minutes and hours) and DAY (days, weeks, and months). This parameter corresponds…"},"DependentType":{"type":"string","enum":["NONE","USER_DEFINE","CHILD","SELF","USER_DEFINE_AND_SELF","CHILD_AND_SELF"],"description":"The dependency on the previous cycle. Valid values: SELF: The current node. CHILD: The child nodes at the first level. USER_DEFINE: Other…"},"DependentNodeIdList":{"type":"string","description":"The IDs of the nodes on which the current file depends when the parameter settings of DependentType are set to USER_DEFINE. Separate…"},"InputList":{"type":"string","description":"The output names of the upstream files on which the current file depends. Separate multiple output names with commas (,). This parameter…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the…"},"FileId":{"type":"integer","description":"The ID of the file. You can call the https://help.aliyun.com/document_detail/173942.html operation to obtain the file ID"},"OutputList":{"type":"string","description":"The output of the file. This parameter corresponds to the Output Name of Current Node parameter in the Schedule > Scheduling Dependencies…"},"ResourceGroupIdentifier":{"type":"string","description":"The resource group used when the task is executed after the file is published as a task. You can call the…"},"ConnectionName":{"type":"string","description":"The identifier of the data source used when the task corresponding to the file is executed. You can call the…"},"Owner":{"type":"string","description":"The user ID of the file owner"},"AutoParsing":{"type":"string","description":"Specifies whether to enable the automatic parsing feature for the file. Valid values: true: The file automatically parses code. false: The…"},"SchedulerType":{"type":"string","enum":["NORMAL","SKIP","PAUSE","MANUAL"],"description":"The scheduling type. Valid values: NORMAL: Normal scheduling task. MANUAL: Manual task. It is not scheduled on a daily basis and…"},"AdvancedSettings":{"type":"string","description":"The advanced settings of the task. This parameter corresponds to the Advanced Settings section in the right-side navigation pane of the…"},"StartImmediately":{"type":"string","description":"Specifies whether to start the task immediately after it is published. Valid values: true: Start the task immediately after it is…"},"InputParameters":{"type":"string","description":"The context input parameters of the node. The parameter value is in JSON format. For the included fields, refer to the…"},"OutputParameters":{"type":"string","description":"The context output parameters of the node. The parameter value is in JSON format. For the included fields, refer to the…"},"IgnoreParentSkipRunningProperty":{"type":"string","description":"This parameter corresponds to the Skip Dry Run of Upstream Nodes parameter that is configured when you set the Dependency parameter to…"},"ApplyScheduleImmediately":{"type":"string","description":"Specifies whether the scheduling configuration takes effect immediately after the file is published"},"Timeout":{"type":"integer","description":"The timeout definition in the scheduling configuration"},"ImageId":{"type":"string","description":"The ID of the custom image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-folder":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_folder","summary":"Invoke UpdateFolder to update the folder information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FolderId","FolderName"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to query the ID. You must…"},"ProjectIdentifier":{"type":"string","description":"The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to query the…"},"FolderId":{"type":"string","description":"The folder ID. You can call the https://help.aliyun.com/document_detail/173955.html operation to obtain the folder ID"},"FolderName":{"type":"string","description":"The folder name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-function":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_function","summary":"Updates the basic information about a user-defined function (UDF) in Data Studio. This API operation…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the workspace…"},"Id":{"type":"string","description":"The unique identifier of the UDF. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the UDF. For more information, see FlowSpec"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-ideevent-result":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_ideevent_result","summary":"Reports the check result of an extension point event message through a callback","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"MessageId":{"type":"string","description":"The message ID of the DataWorks open message. After an extension point event is triggered, you can obtain the message ID from the received…"},"ExtensionCode":{"type":"string","description":"The unique identifier of the extension. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and view the…"},"CheckResult":{"type":"string","description":"The check status of the extension for this extension point event. Valid values: OK: The extension check for this extension point event…"},"CheckResultTip":{"type":"string","description":"The summary of the check performed by the extension on this extension point event. This information is displayed on your current…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-image":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_image","summary":"Updates an image","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The image ID"},"Name":{"type":"string","description":"The image name"},"Description":{"type":"string","description":"The image description"},"Accessibility":{"type":"string","enum":["Public","Private"],"description":"The image visibility. Valid values: Public: Visible to all users. Private: Visible only to the creator"},"Supported":{"type":"string","description":"The image sub-purpose (JSON-encoded)"},"BuildConfig":{"type":"string","description":"The image build configuration (JSON-encoded)"},"ProviderImageId":{"type":"string","description":"The ID of the image provided by the provider. This parameter is required when you reference an official DataWorks image"},"AcrInstanceId":{"type":"string","description":"The ID of the Container Registry (ACR) instance. This parameter is required when you reference an ACR image"},"Namespace":{"type":"string","description":"The image namespace. If you reference an official DataWorks image, set this parameter to DataWorks Default"},"RepositoryName":{"type":"string","description":"The image repository name. If you reference an official DataWorks image, set this parameter to DataWorks Default"},"ImageUri":{"type":"string","description":"The image URI. This parameter is required when you reference an ACR image"},"AcrAssociatedVpcId":{"type":"string","description":"The ID of the VPC associated with the ACR instance. This parameter is required when you reference an ACR image"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-mcp-server":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_mcp_server","summary":"Updates an MCP server","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the MCP server to update"},"Url":{"type":"string","description":"The new service URL. The URL must start with `https://`"},"Transport":{"type":"string","enum":["STREAMABLE_HTTP","SSE"],"description":"The new transport protocol"},"CustomHeaders":{"type":"string","description":"The new custom request headers in key-value pairs (JSON-encoded)"},"Visibility":{"type":"string","enum":["TENANT","PROJECT","USER"],"description":"The new visibility level"},"VisibilityScope":{"type":"string","description":"The new visibility scope. Specify the corresponding fields based on the `Visibility` value (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-meta-collection":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_meta_collection","summary":"Update Data Map collection objects, including Data Map categories and data albums. You can update the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The collection ID"},"Name":{"type":"string","description":"Updated collection name"},"Description":{"type":"string","description":"Updated collection description"},"Administrators":{"type":"string","description":"The collection administrator IDs. This parameter is available only for data albums. The administrator must be an account within the same…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-meta-entity":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_meta_entity","summary":"Updates a metadata entity. You can update custom entities or objects of the extended table type, such as…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the entity to update. The entity name, entity type, and parent-child relationship are determined by the ID and cannot be…"},"Comment":{"type":"string","description":"The comment on the entity"},"Attributes":{"type":"string","description":"The entity attributes. Complex values must be serialized into a JSON string (JSON-encoded)"},"CustomAttributes":{"type":"string","description":"The custom attribute values. Each key specifies a custom attribute, and its value is an array that can contain at most one item. To delete…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-meta-entity-def":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_meta_entity_def","summary":"Updates a metadata entity definition, including custom entity types and extension table types","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["EntityType"],"properties":{"EntityType":{"type":"string","description":"The entity type"},"DisplayName":{"type":"string","description":"The new display name, up to 32 characters"},"Description":{"type":"string","description":"The new description"},"NewAttributeDefs":{"type":"string","description":"The new attribute definitions. New attributes must be optional (JSON-encoded)"},"UpdateAttributeDefs":{"type":"string","description":"Updates to existing attribute definitions. Only modifying the display name, description, and appending enum values to ENUM types are…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-node":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_node","summary":"Updates the basic information about a node in Data Studio. This API operation performs an incremental…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio node. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the node. For the specification, see FlowSpec. How to quickly obtain a FlowSpec template Open the…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-parameter":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_parameter","summary":"Updates a parameter. This operation performs an incremental update and modifies only the specified fields","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The parameter ID"},"Properties":{"type":"string","description":"The parameter value configuration. This parameter is required for the production environment. If you specify the same environment multiple…"},"Owner":{"type":"string","description":"The owner's account ID"},"Description":{"type":"string","description":"The parameter description"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-process-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_process_definition","summary":"Updates an existing approval process definition","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the process definition"},"Name":{"type":"string","description":"The name of the process definition"},"Description":{"type":"string","description":"The description of the process definition"},"RuleConditions":{"type":"string","description":"A list of rule conditions. This parameter does not apply to system policies (JSON-encoded)"},"NotificationServices":{"type":"string","description":"The notification service configurations (JSON-encoded)"},"ApprovalNodes":{"type":"string","description":"A list of approval nodes. This parameter does not apply to system policies (JSON-encoded)"},"ClientToken":{"type":"string","description":"An idempotent parameter. It ensures that retried requests do not result in duplicate operations"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-project":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_project","summary":"This operation updates a DataWorks workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The ID of the DataWorks workspace. To find the workspace ID, log in to the DataWorks console…"},"Description":{"type":"string","description":"An optional description of the workspace"},"Status":{"type":"string","enum":["Forbidden","Available"],"description":"Specifies whether to enable or disable the workspace. Valid values: `Available`: Enables the workspace. `Forbidden`: Disables the workspace"},"DevEnvironmentEnabled":{"type":"string","description":"Specifies whether to enable the development environment. Valid values: `true`: Enables the development environment for the workspace and…"},"DevRoleDisabled":{"type":"string","description":"Specifies whether to disable the development role, which grants permissions for workflow and code editing. Valid values: `false`: Enables…"},"DisplayName":{"type":"string","description":"The display name of the workspace"},"PaiTaskEnabled":{"type":"string","description":"Specifies whether to enable task scheduling for Machine Learning Platform for AI (PAI). Valid values: `true`: You can create PAI nodes in…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-project-role":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_project_role","summary":"Updates the permissions of a custom role in a workspace","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Code","ModulePermissions"],"properties":{"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can log on to the DataWorks console (https://dataworks.console.aliyun.com/workspace/list) and go to…"},"Code":{"type":"string","description":"The unique identifier of the custom role"},"ModulePermissions":{"type":"string","description":"The list of DataWorks module permissions (JSON-encoded)"},"ClientToken":{"type":"string","description":"A reserved field"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-resource":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_resource","summary":"Updates the basic information about a file resource in Data Studio. This API operation performs an…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio file resource. This field is of type Long in SDK versions prior to 8.0.0, and of type String in…"},"Spec":{"type":"string","description":"The FlowSpec information that describes the Data Studio file resource. For more information, see FlowSpec"},"ResourceFile":{"type":"string","description":"The specific file stream or OSS download link contained in the resource. This field allows users to provide a file stream or an OSS…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-resource-group":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_resource_group","summary":"Updates basic information about a resource group","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the resource group"},"Name":{"type":"string","description":"The new name that you want to change for the resource group"},"Remark":{"type":"string","description":"The new remarks that you want to modify for the resource group"},"AliyunResourceGroupId":{"type":"string","description":"The ID of the new Alibaba Cloud resource group"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-route":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_route","summary":"Updates the information about a route","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","DestinationCidr"],"properties":{"Id":{"type":"integer","description":"The route ID of the network resource"},"DestinationCidr":{"type":"string","description":"The destination CIDR block of the route that you want to update"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-security-strategy":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_security_strategy","summary":"To modify the configuration of an existing security policy, you must be both a DataWorks tenant…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","Content"],"properties":{"Id":{"type":"integer","description":"The policy ID"},"Name":{"type":"string","description":"The policy name"},"Description":{"type":"string","description":"The policy description"},"Workspaces":{"type":"string","description":"A list of associated workspace IDs (JSON-encoded)"},"Content":{"type":"string","description":"The policy content, which is constrained by the `SecurityStrategySchema` (JSON-encoded)"},"ClientToken":{"type":"string","description":"A client token to ensure request idempotence"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-server-ide-instance":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_server_ide_instance","summary":"Updates the configuration of a specified personal development environment instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["InstanceId"],"properties":{"InstanceId":{"type":"string","description":"The personal development environment instance ID. You can call ListServerIdeInstances to obtain the ID"},"ProjectId":{"type":"integer","description":"The DataWorks workspace ID"},"Cu":{"type":"integer","description":"The number of CUs used by the instance"},"ImageId":{"type":"string","description":"The image ID. You can call ListServerIdeImages to obtain the ID"},"ImageUrl":{"type":"string","description":"The image URL. This parameter is required when you use a non-DataWorks official image"},"InstanceName":{"type":"string","description":"The name of the personal development environment instance"},"UserVpc":{"type":"string","description":"The VPC configuration used by the instance (JSON-encoded)"},"Datasets":{"type":"string","description":"The list of datasets mounted to the instance (JSON-encoded)"},"CredentialConfig":{"type":"string","description":"The credential injection configuration for the instance. After this feature is enabled, you can use the default RAM role chain or specify…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-skill":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_skill","summary":"Updates a specified Skill and generates a new version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"type":"string","description":"The name of the Skill to update"},"ExpectedVersion":{"type":"integer","description":"The expected version number for optimistic locking. If not specified, the update is based on the current highest version"},"Description":{"type":"string","description":"The Skill description"},"VersionNote":{"type":"string","description":"The version note"},"SkillMdOverride":{"type":"string","description":"The SKILL.md body content. Mutually exclusive with BundleUrl"},"BundleUrl":{"type":"string","description":"The downloadable URL (HTTP/HTTPS) of the bundle.zip file. Mutually exclusive with SkillMdOverride. If provided, the bundle is replaced"},"Extra":{"type":"string","description":"The extended metadata (key-value pairs) (JSON-encoded)"},"VisibilityScope":{"type":"string","description":"The visibility scope. The corresponding field is used based on the visibility level (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-table-business-metadata":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_table_business_metadata","summary":"Updates the business metadata of a table in Data Map. Currently, only the table usage description and custom…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"string","description":"The ID of the table. For the format, refer to the response of the ListTables operation"},"Readme":{"type":"string","description":"The usage description. Rich text format is supported"},"CustomAttributes":{"type":"string","description":"The custom attribute values. The key is the custom attribute identifier, and the value contains at most one element. An empty list…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-task":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_task","summary":"Updates a specified node. The modifications are synchronized to Data Studio, where a new saved version is…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The node ID"},"ClientUniqueCode":{"type":"string","description":"The client unique code of the node, used to uniquely identify a node. This code is used to implement asynchronous operations and…"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production. Dev: development"},"Name":{"type":"string","description":"The name"},"Description":{"type":"string","description":"The description"},"Owner":{"type":"string","description":"The account ID of the node owner"},"InstanceMode":{"type":"string","enum":["T+1","Immediately"],"description":"The instance generation mode. Valid values: T+1: The instance is generated the next day. Immediately: The instance is generated…"},"Timeout":{"type":"integer","description":"The node execution timeout period, in seconds. The value must be greater than 3600"},"RerunMode":{"type":"string","enum":["AllAllowed","FailureAllowed","AllDenied"],"description":"Specifies whether the node can be rerun. Valid values: AllDenied: The node cannot be rerun regardless of whether it succeeds or fails.…"},"RerunTimes":{"type":"integer","description":"The number of retries. This parameter takes effect when the node is configured to allow reruns"},"RerunInterval":{"type":"integer","description":"The retry time interval, in milliseconds. The value cannot exceed 1800000"},"Script":{"type":"string","description":"The script information (JSON-encoded)"},"Trigger":{"type":"string","description":"The node trigger method (JSON-encoded)"},"RuntimeResource":{"type":"string","description":"The environment configuration, such as resource group information (JSON-encoded)"},"DataSource":{"type":"string","description":"The associated data source information (JSON-encoded)"},"Inputs":{"type":"string","description":"The input information (JSON-encoded)"},"Outputs":{"type":"string","description":"The output information (JSON-encoded)"},"Dependencies":{"type":"string","description":"The dependency information (JSON-encoded)"},"Tags":{"type":"string","description":"The list of node tags (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-task-async":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_task_async","summary":"Asynchronously updates a specified node and syncs the changes to Data Studio as a new saved version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id"],"properties":{"Id":{"type":"integer","description":"The node ID"},"ClientUniqueCode":{"type":"string","description":"The client unique code of the node, used to uniquely identify a node. This code is used for asynchronous processing and idempotence. If…"},"EnvType":{"type":"string","enum":["Prod","Dev"],"description":"The project environment. Valid values: Prod: production Dev: development"},"Name":{"type":"string","description":"The name"},"Description":{"type":"string","description":"The description"},"Owner":{"type":"string","description":"The account ID of the node owner. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and hover over the…"},"InstanceMode":{"type":"string","enum":["T+1","Immediately"],"description":"The instance generation mode. Valid values: T+1: generates instances the next day. Immediately: generates instances immediately. Note:…"},"Timeout":{"type":"integer","description":"The timeout period defined in the scheduling configuration"},"RerunMode":{"type":"string","enum":["AllAllowed","FailureAllowed","AllDenied"],"description":"The configuration that specifies whether the node can be rerun. Valid values: AllDenied: the node cannot be rerun regardless of whether it…"},"RerunTimes":{"type":"integer","description":"The number of retries. This parameter takes effect only when the node is configured to allow reruns"},"RerunInterval":{"type":"integer","description":"The retry time interval, in milliseconds. The value cannot exceed 1800000"},"Script":{"type":"string","description":"The runtime script information (JSON-encoded)"},"Trigger":{"type":"string","description":"The trigger method of the node (JSON-encoded)"},"RuntimeResource":{"type":"string","description":"The runtime environment configuration, such as the resource group information (JSON-encoded)"},"DataSource":{"type":"string","description":"The associated data source information (JSON-encoded)"},"Inputs":{"type":"string","description":"The input information (JSON-encoded)"},"Outputs":{"type":"string","description":"The output information (JSON-encoded)"},"Dependencies":{"type":"string","description":"The dependency information (JSON-encoded)"},"Tags":{"type":"string","description":"The list of data asset tags to attach (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-task-instances":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_task_instances","summary":"Modify the properties of multiple task instances in batch, including priority, resource group, data source,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"TaskInstances":{"type":"string","description":"The instances (JSON-encoded)"},"Comment":{"type":"string","description":"The remarks"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-udf-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_udf_file","summary":"Updates the file information of a function","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FunctionType","ClassName","Resources","FileId"],"properties":{"FileFolderPath":{"type":"string","description":"The path of the folder where the function file is located"},"ProjectId":{"type":"integer","description":"The ID of the DataWorks workspace. You can view the ID on the Workspace Management page by clicking the Settings icon in the upper-right…"},"FunctionType":{"type":"string","enum":["MATH","AGGREGATE","STRING","DATE","ANALYTIC","OTHER"],"description":"The category of the function, which corresponds to the function type in the create function form. Valid values: MATH (mathematical…"},"ClassName":{"type":"string","description":"The name of the class where the function is defined, which corresponds to the class name in the create function form"},"Resources":{"type":"string","description":"The list of resource names referenced by the function. Separate multiple resource names with commas (,). This corresponds to the resources…"},"UdfDescription":{"type":"string","description":"The description of the function purpose, which corresponds to the description in the create function form"},"CmdDescription":{"type":"string","description":"The command format used to call the function, which corresponds to the command format in the create function form"},"ParameterDescription":{"type":"string","enum":["ALL_ALLOWD","FAILURE_ALLOWED","ALL_DENIED"],"description":"The description of the input parameters for the function, which corresponds to the parameter description in the create function form"},"ReturnValue":{"type":"string","description":"The description of the return value of the function, which corresponds to the return value in the create function form"},"Example":{"type":"string","description":"The call example of the function, which corresponds to the example in the create function form"},"ProjectIdentifier":{"type":"string","description":"The unique identifier of the DataWorks workspace, which is the English identifier displayed when you switch workspaces at the top of the…"},"FileId":{"type":"string","description":"The ID of the file"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-workflow":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_workflow","summary":"Updates a specified workflow by using the full update method. Fields that can be synchronously updated to…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Id","Name","Owner","Trigger"],"properties":{"Id":{"type":"integer","description":"The workflow ID"},"EnvType":{"type":"string","enum":["Prod"],"description":"The project environment. Valid values: Prod: production Dev: development"},"Name":{"type":"string","description":"The name"},"Owner":{"type":"string","description":"The account ID of the owner"},"Trigger":{"type":"string","description":"The trigger configuration (JSON-encoded)"},"Description":{"type":"string","description":"The description"},"Dependencies":{"type":"string","description":"The dependency information (JSON-encoded)"},"Parameters":{"type":"string","description":"The parameter list"},"Tasks":{"type":"string","description":"The node list (JSON-encoded)"},"Outputs":{"type":"string","description":"The output information (JSON-encoded)"},"Tags":{"type":"string","description":"The list of workflow tags (JSON-encoded)"},"ClientUniqueCode":{"type":"string","description":"The client unique code of the workflow, used for asynchronous operations and idempotence. If not specified during creation, the system…"},"InstanceMode":{"type":"string","enum":["T+1","Immediately"],"description":"The instance generation mode. Valid values: T+1: Instances are generated the next day. Immediately: Instances are generated immediately.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/update-workflow-definition":{"post":{"operationId":"cloud_aliyun_dataworks_public_update_workflow_definition","summary":"Updates the basic information about a workflow in Data Studio. This API operation performs an incremental…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProjectId","Id","Spec"],"properties":{"ProjectId":{"type":"integer","description":"The DataWorks workspace ID. You can log on to the DataWorks console (https://workbench.data.aliyun.com/console) and go to the Workspace…"},"Id":{"type":"string","description":"The unique identifier of the Data Studio workflow. This field is of the Long type in SDK versions prior to 8.0.0, and of the String type…"},"Spec":{"type":"string","description":"The FlowSpec information that describes this workflow. For specification details, see FlowSpec. This operation updates only the workflow's…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/upload-semantic-file":{"post":{"operationId":"cloud_aliyun_dataworks_public_upload_semantic_file","summary":"Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, then pass the…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["FileName","ContentType","SizeBytes"],"properties":{"FileName":{"type":"string","description":"The original file name of the reference file to upload. Maximum length: 255 characters. When singleTableFile uses a FileId, only CSV or…"},"ContentType":{"type":"string","description":"The MIME type of the object to upload. Maximum length: 128 characters. This value is included in the UploadUrl signature. Use the same…"},"SizeBytes":{"type":"integer","description":"The size of the file to upload, in bytes. This value is recorded as attachment metadata. Specify the actual file size"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-dataworks-public/version":{"post":{"operationId":"cloud_aliyun_dataworks_public_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}