CreatePluginWorkspace-阿里云帮助中心

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apig:CreatePluginWorkspace

none

*All Resource

*

None

Request syntax

POST /v1/plugin-workspaces HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request parameters.
gatewayType	string	No	The gateway type. If this parameter is not specified, the server uses API as the default value.	AI
organizationId	string	Yes	The Codeup organization ID. This is the Yunxiao DevOps organization ID, which can be obtained by parsing the response of the ListPluginRepositories operation or by creating an organization.	664f1e2xxxx
repoName	string	Yes	The repository name, which also serves as the English ID of the plugin. The backend does not validate the format. The frontend restricts the value to the pattern /^(?![-.])[a-z0-9.-]{1,20}(?<![-.])$/, which means 1 to 20 lowercase letters, digits, periods, or hyphens that cannot start or end with a period or hyphen.	my-custom-plugin
workspaceName	string	No	The workspace name, which is the Chinese name of the plugin. This parameter is required. If you do not specify this parameter, the API returns a 400 InvalidParameter.IsEmpty error.	my-plugin

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The response status code.	200
data	object	The response data.
repoId	string	The Codeup repository ID, which is a numeric string.	12345678
workspaceId	string	The workspace ID.	plw-xxxxxxxx
message	string	The response message.	success
requestId	string	The request ID.	01A02219-8028-57D8-9D60-2D167FF9118E

Examples

Success response

JSON format

{
  "code": "200",
  "data": {
    "repoId": "12345678",
    "workspaceId": "plw-xxxxxxxx"
  },
  "message": "success",
  "requestId": "01A02219-8028-57D8-9D60-2D167FF9118E"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.IsEmpty	Parameter workspaceName should not be empty.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.