GetWorkspaceCodePublishSetting-阿里云帮助中心

Retrieves the deployment configuration of a workspace.

Operation description

This operation retrieves the deployment configuration of a workspace. The configuration includes details such as repository and branch information, and directories to exclude.

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 parameters

Parameter	Type	Required	Description	Example
WorkspaceId	string	Yes	The ID of the workspace.	8630242382****

Response elements

Element	Type	Description	Example
	object	The response object.
Message	string	The error message returned if the request fails.	This record is being collected, please wait for a moment.
Data	object	The returned data.
Repos	array<object>	The Git repositories in the workspace.
	object
Repo	string	The name of the repository.	analyticscomputing/dide
Path	string	The path to the notebook file.	/luna-public/
Branch	string	The name of the branch.	main
Exclude	array	The files and directories to exclude from the deployment.
	string	A file or directory pattern to exclude from the deployment.	[\"/exclude_*.log\", \"temp_file.tmp\"]
LockRepoBranch	boolean	Indicates whether the deployment branch is locked. If `true`, configurations submitted via the `workspaceCodePublish` API are ignored. If `false`, configurations submitted via the `workspaceCodePublish` API update the settings.	false
RequestId	string	The request ID.	E0D21075-CD3E-4D98-8264-FD8AD04A63B6
HttpStatusCode	integer	The HTTP status code.	200
ErrorCode	string	The error code.	UnknownError
Code	string	The status code that indicates the result of the request. A value of `200` indicates that the request was successful.	200

Examples

Success response

JSON format

{
  "Message": "This record is being collected, please wait for a moment.",
  "Data": {
    "Repos": [
      {
        "Repo": "analyticscomputing/dide",
        "Path": "/luna-public/",
        "Branch": "main"
      }
    ],
    "Exclude": [
      "[\\\"/exclude_*.log\\\", \\\"temp_file.tmp\\\"]"
    ],
    "LockRepoBranch": false
  },
  "RequestId": "E0D21075-CD3E-4D98-8264-FD8AD04A63B6",
  "HttpStatusCode": 200,
  "ErrorCode": "UnknownError",
  "Code": "200"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.