GetAgentSessionArtifactMeta - DataWorks - Alibaba Cloud Documentation Center

Operation description

Description

This operation retrieves the metadata and content of a single artifact based on SessionId and ArtifactPath.
SessionId and ArtifactPath are required.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
Jsonrpc	string	No	The JSON-RPC version. The value is `2.0`.	2.0
Id	string	No	A client-provided ID that is echoed in the response.	900335678024
Params	object	No	The container for business parameters.
SessionId	string	No	The ID of the session.	sess_0f12abc34
ArtifactPath	string	No	The path of the artifact.	mock/mock_report.md

Response elements

Element	Type	Description	Example
	object	The response schema.
RequestId	string	The ID of the request. You can use it to trace the request in logs.	CE70C54F-A3BD-5C19-88EF-2A7D3451C449
JsonRpcResponse	object	The JSON-RPC response object.
Jsonrpc	string	The JSON-RPC version. The value is `2.0`.	2.0
Id	string	The ID from the original request.	300010555
Result	object	Contains the metadata and content of the artifact.
ArtifactPath	string	The path of the artifact.	mock/mock_report.md
ArtifactName	string	The name of the artifact.	mock_report.md
ArtifactContent	string	The content of the artifact.	This is md content

Examples

Success response

JSON format

{
  "RequestId": "CE70C54F-A3BD-5C19-88EF-2A7D3451C449",
  "JsonRpcResponse": {
    "Jsonrpc": "2.0",
    "Id": "300010555",
    "Result": {
      "ArtifactPath": "mock/mock_report.md",
      "ArtifactName": "mock_report.md",
      "ArtifactContent": "This is md content"
    }
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.