v20230508

package
v1.0.941 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// 工作空间名称重复
	FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 请求的次数超过了频率限制。
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
)
View Source 
const APIVersion = "2023-05-08"

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) CreateWorkspace 

func (c *Client) CreateWorkspace(request *CreateWorkspaceRequest) (response *CreateWorkspaceResponse, err error)

CreateWorkspace 创建工作空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) CreateWorkspaceToken 

func (c *Client) CreateWorkspaceToken(request *CreateWorkspaceTokenRequest) (response *CreateWorkspaceTokenResponse, err error)

CreateWorkspaceToken 创建工作空间临时访问凭证，重复调用会创建新的 Token，旧的 Token 将会自动失效

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) CreateWorkspaceTokenWithContext 

func (c *Client) CreateWorkspaceTokenWithContext(ctx context.Context, request *CreateWorkspaceTokenRequest) (response *CreateWorkspaceTokenResponse, err error)

CreateWorkspaceToken 创建工作空间临时访问凭证，重复调用会创建新的 Token，旧的 Token 将会自动失效

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) CreateWorkspaceWithContext 

func (c *Client) CreateWorkspaceWithContext(ctx context.Context, request *CreateWorkspaceRequest) (response *CreateWorkspaceResponse, err error)

CreateWorkspace 创建工作空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

func (*Client) DescribeConfig 

func (c *Client) DescribeConfig(request *DescribeConfigRequest) (response *DescribeConfigResponse, err error)

DescribeConfig 获取用户配置

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeConfigWithContext 

func (c *Client) DescribeConfigWithContext(ctx context.Context, request *DescribeConfigRequest) (response *DescribeConfigResponse, err error)

DescribeConfig 获取用户配置

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeImages 

func (c *Client) DescribeImages(request *DescribeImagesRequest) (response *DescribeImagesResponse, err error)

DescribeImages 获取基础镜像列表

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeImagesWithContext 

func (c *Client) DescribeImagesWithContext(ctx context.Context, request *DescribeImagesRequest) (response *DescribeImagesResponse, err error)

DescribeImages 获取基础镜像列表

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeWorkspaces 

func (c *Client) DescribeWorkspaces(request *DescribeWorkspacesRequest) (response *DescribeWorkspacesResponse, err error)

DescribeWorkspaces 获取用户工作空间列表

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) DescribeWorkspacesWithContext 

func (c *Client) DescribeWorkspacesWithContext(ctx context.Context, request *DescribeWorkspacesRequest) (response *DescribeWorkspacesResponse, err error)

DescribeWorkspaces 获取用户工作空间列表

可能返回的错误码: 

INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) ModifyWorkspace 

func (c *Client) ModifyWorkspace(request *ModifyWorkspaceRequest) (response *ModifyWorkspaceResponse, err error)

ModifyWorkspace 修改工作空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) ModifyWorkspaceWithContext 

func (c *Client) ModifyWorkspaceWithContext(ctx context.Context, request *ModifyWorkspaceRequest) (response *ModifyWorkspaceResponse, err error)

ModifyWorkspace 修改工作空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) RemoveWorkspace 

func (c *Client) RemoveWorkspace(request *RemoveWorkspaceRequest) (response *RemoveWorkspaceResponse, err error)

RemoveWorkspace 删除工作空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) RemoveWorkspaceWithContext 

func (c *Client) RemoveWorkspaceWithContext(ctx context.Context, request *RemoveWorkspaceRequest) (response *RemoveWorkspaceResponse, err error)

RemoveWorkspace 删除工作空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_WORKSPACENAMEDUPLICATE = "FailedOperation.WorkspaceNameDuplicate"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) RunWorkspace 

func (c *Client) RunWorkspace(request *RunWorkspaceRequest) (response *RunWorkspaceResponse, err error)

RunWorkspace 运行空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) RunWorkspaceWithContext 

func (c *Client) RunWorkspaceWithContext(ctx context.Context, request *RunWorkspaceRequest) (response *RunWorkspaceResponse, err error)

RunWorkspace 运行空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) StopWorkspace 

func (c *Client) StopWorkspace(request *StopWorkspaceRequest) (response *StopWorkspaceResponse, err error)

StopWorkspace 停止运行空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

func (*Client) StopWorkspaceWithContext 

func (c *Client) StopWorkspaceWithContext(ctx context.Context, request *StopWorkspaceRequest) (response *StopWorkspaceResponse, err error)

StopWorkspace 停止运行空间

可能返回的错误码: 

FAILEDOPERATION = "FailedOperation"

type CreateWorkspaceRequest 

type CreateWorkspaceRequest struct {
	*tchttp.BaseRequest

	// 工作空间名称, 长度限制 2~64
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 工作空间描述, 长度限制 0~255
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 工作空间规格。Standard: 2C4G, Calculation: 4C8G, Profession: 8C16G. 默认是 Standard。
	Specs *string `json:"Specs,omitnil,omitempty" name:"Specs"`

	// 工作空间基础镜像名称, 默认会使用 All In One 镜像, 长度限制 1~255
	Image *string `json:"Image,omitnil,omitempty" name:"Image"`

	// Git 仓库. 工作空间启动时会自动克隆该仓库
	Repository *GitRepository `json:"Repository,omitnil,omitempty" name:"Repository"`

	// 环境变量. 会被注入到工作空间中
	Envs []*Env `json:"Envs,omitnil,omitempty" name:"Envs"`

	// 预装插件. 工作空间启动时, 会自动安装这些插件。长度限制: 0~10
	Extensions []*string `json:"Extensions,omitnil,omitempty" name:"Extensions"`

	// 工作空间生命周期钩子.  分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段.  用户可以自定义 shell 命令.
	Lifecycle *LifeCycle `json:"Lifecycle,omitnil,omitempty" name:"Lifecycle"`

	// 应用名称
	TenantAppId *int64 `json:"TenantAppId,omitnil,omitempty" name:"TenantAppId"`

	// 用户UIN
	TenantUin *string `json:"TenantUin,omitnil,omitempty" name:"TenantUin"`

	// VPCID
	TenantUniqVpcId *string `json:"TenantUniqVpcId,omitnil,omitempty" name:"TenantUniqVpcId"`

	// 子网ID
	TenantSubnetId *string `json:"TenantSubnetId,omitnil,omitempty" name:"TenantSubnetId"`

	// 地域
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`
}

func NewCreateWorkspaceRequest 

func NewCreateWorkspaceRequest() (request *CreateWorkspaceRequest)

func (*CreateWorkspaceRequest) FromJsonString 

func (r *CreateWorkspaceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateWorkspaceRequest) ToJsonString 

func (r *CreateWorkspaceRequest) ToJsonString() string

type CreateWorkspaceRequestParams 

type CreateWorkspaceRequestParams struct {
	// 工作空间名称, 长度限制 2~64
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 工作空间描述, 长度限制 0~255
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 工作空间规格。Standard: 2C4G, Calculation: 4C8G, Profession: 8C16G. 默认是 Standard。
	Specs *string `json:"Specs,omitnil,omitempty" name:"Specs"`

	// 工作空间基础镜像名称, 默认会使用 All In One 镜像, 长度限制 1~255
	Image *string `json:"Image,omitnil,omitempty" name:"Image"`

	// Git 仓库. 工作空间启动时会自动克隆该仓库
	Repository *GitRepository `json:"Repository,omitnil,omitempty" name:"Repository"`

	// 环境变量. 会被注入到工作空间中
	Envs []*Env `json:"Envs,omitnil,omitempty" name:"Envs"`

	// 预装插件. 工作空间启动时, 会自动安装这些插件。长度限制: 0~10
	Extensions []*string `json:"Extensions,omitnil,omitempty" name:"Extensions"`

	// 工作空间生命周期钩子.  分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段.  用户可以自定义 shell 命令.
	Lifecycle *LifeCycle `json:"Lifecycle,omitnil,omitempty" name:"Lifecycle"`

	// 应用名称
	TenantAppId *int64 `json:"TenantAppId,omitnil,omitempty" name:"TenantAppId"`

	// 用户UIN
	TenantUin *string `json:"TenantUin,omitnil,omitempty" name:"TenantUin"`

	// VPCID
	TenantUniqVpcId *string `json:"TenantUniqVpcId,omitnil,omitempty" name:"TenantUniqVpcId"`

	// 子网ID
	TenantSubnetId *string `json:"TenantSubnetId,omitnil,omitempty" name:"TenantSubnetId"`

	// 地域
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`
}

Predefined struct for user

type CreateWorkspaceResponse 

type CreateWorkspaceResponse struct {
	*tchttp.BaseResponse
	Response *CreateWorkspaceResponseParams `json:"Response"`
}

func NewCreateWorkspaceResponse 

func NewCreateWorkspaceResponse() (response *CreateWorkspaceResponse)

func (*CreateWorkspaceResponse) FromJsonString 

func (r *CreateWorkspaceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateWorkspaceResponse) ToJsonString 

func (r *CreateWorkspaceResponse) ToJsonString() string

type CreateWorkspaceResponseParams 

type CreateWorkspaceResponseParams struct {
	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`

	// 工作空间名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateWorkspaceTokenRequest 

type CreateWorkspaceTokenRequest struct {
	*tchttp.BaseRequest

	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`

	// token过期时间，单位是秒，默认 3600
	TokenExpiredLimitSec *uint64 `json:"TokenExpiredLimitSec,omitnil,omitempty" name:"TokenExpiredLimitSec"`

	// token 授权策略，可选值为 workspace-run-only, all。默认为 workspace-run-only
	Policies []*string `json:"Policies,omitnil,omitempty" name:"Policies"`
}

func NewCreateWorkspaceTokenRequest 

func NewCreateWorkspaceTokenRequest() (request *CreateWorkspaceTokenRequest)

func (*CreateWorkspaceTokenRequest) FromJsonString 

func (r *CreateWorkspaceTokenRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateWorkspaceTokenRequest) ToJsonString 

func (r *CreateWorkspaceTokenRequest) ToJsonString() string

type CreateWorkspaceTokenRequestParams 

type CreateWorkspaceTokenRequestParams struct {
	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`

	// token过期时间，单位是秒，默认 3600
	TokenExpiredLimitSec *uint64 `json:"TokenExpiredLimitSec,omitnil,omitempty" name:"TokenExpiredLimitSec"`

	// token 授权策略，可选值为 workspace-run-only, all。默认为 workspace-run-only
	Policies []*string `json:"Policies,omitnil,omitempty" name:"Policies"`
}

Predefined struct for user

type CreateWorkspaceTokenResponse 

type CreateWorkspaceTokenResponse struct {
	*tchttp.BaseResponse
	Response *CreateWorkspaceTokenResponseParams `json:"Response"`
}

func NewCreateWorkspaceTokenResponse 

func NewCreateWorkspaceTokenResponse() (response *CreateWorkspaceTokenResponse)

func (*CreateWorkspaceTokenResponse) FromJsonString 

func (r *CreateWorkspaceTokenResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateWorkspaceTokenResponse) ToJsonString 

func (r *CreateWorkspaceTokenResponse) ToJsonString() string

type CreateWorkspaceTokenResponseParams 

type CreateWorkspaceTokenResponseParams struct {
	// 访问工作空间临时凭证
	Token *string `json:"Token,omitnil,omitempty" name:"Token"`

	// token 过期时间
	ExpiredTime *string `json:"ExpiredTime,omitnil,omitempty" name:"ExpiredTime"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeConfigRequest 

type DescribeConfigRequest struct {
	*tchttp.BaseRequest

	// 配置名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

func NewDescribeConfigRequest 

func NewDescribeConfigRequest() (request *DescribeConfigRequest)

func (*DescribeConfigRequest) FromJsonString 

func (r *DescribeConfigRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeConfigRequest) ToJsonString 

func (r *DescribeConfigRequest) ToJsonString() string

type DescribeConfigRequestParams 

type DescribeConfigRequestParams struct {
	// 配置名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

Predefined struct for user

type DescribeConfigResponse 

type DescribeConfigResponse struct {
	*tchttp.BaseResponse
	Response *DescribeConfigResponseParams `json:"Response"`
}

func NewDescribeConfigResponse 

func NewDescribeConfigResponse() (response *DescribeConfigResponse)

func (*DescribeConfigResponse) FromJsonString 

func (r *DescribeConfigResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeConfigResponse) ToJsonString 

func (r *DescribeConfigResponse) ToJsonString() string

type DescribeConfigResponseParams 

type DescribeConfigResponseParams struct {
	// 配置值
	// 注意：此字段可能返回 null，表示取不到有效值。
	Data *string `json:"Data,omitnil,omitempty" name:"Data"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeImagesRequest 

type DescribeImagesRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeImagesRequest 

func NewDescribeImagesRequest() (request *DescribeImagesRequest)

func (*DescribeImagesRequest) FromJsonString 

func (r *DescribeImagesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeImagesRequest) ToJsonString 

func (r *DescribeImagesRequest) ToJsonString() string

type DescribeImagesRequestParams 

type DescribeImagesRequestParams struct {
}

Predefined struct for user

type DescribeImagesResponse 

type DescribeImagesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeImagesResponseParams `json:"Response"`
}

func NewDescribeImagesResponse 

func NewDescribeImagesResponse() (response *DescribeImagesResponse)

func (*DescribeImagesResponse) FromJsonString 

func (r *DescribeImagesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeImagesResponse) ToJsonString 

func (r *DescribeImagesResponse) ToJsonString() string

type DescribeImagesResponseParams 

type DescribeImagesResponseParams struct {
	// 镜像列表
	Images []*Image `json:"Images,omitnil,omitempty" name:"Images"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWorkspacesRequest 

type DescribeWorkspacesRequest struct {
	*tchttp.BaseRequest

	// 工作空间名称过滤条件
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

func NewDescribeWorkspacesRequest 

func NewDescribeWorkspacesRequest() (request *DescribeWorkspacesRequest)

func (*DescribeWorkspacesRequest) FromJsonString 

func (r *DescribeWorkspacesRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWorkspacesRequest) ToJsonString 

func (r *DescribeWorkspacesRequest) ToJsonString() string

type DescribeWorkspacesRequestParams 

type DescribeWorkspacesRequestParams struct {
	// 工作空间名称过滤条件
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

Predefined struct for user

type DescribeWorkspacesResponse 

type DescribeWorkspacesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWorkspacesResponseParams `json:"Response"`
}

func NewDescribeWorkspacesResponse 

func NewDescribeWorkspacesResponse() (response *DescribeWorkspacesResponse)

func (*DescribeWorkspacesResponse) FromJsonString 

func (r *DescribeWorkspacesResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWorkspacesResponse) ToJsonString 

func (r *DescribeWorkspacesResponse) ToJsonString() string

type DescribeWorkspacesResponseParams 

type DescribeWorkspacesResponseParams struct {
	// 工作空间列表
	Data []*WorkspaceStatusInfo `json:"Data,omitnil,omitempty" name:"Data"`

	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Env 

type Env struct {
	// 环境变量 key
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 环境变量 value
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type GitRepository 

type GitRepository struct {
	// Git 仓库地址
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// Git 仓库分支名或 Tag 名
	Branch *string `json:"Branch,omitnil,omitempty" name:"Branch"`
}

type Image 

type Image struct {
	// 镜像名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 镜像仓库
	Repository *string `json:"Repository,omitnil,omitempty" name:"Repository"`

	// tag 列表
	Tags []*string `json:"Tags,omitnil,omitempty" name:"Tags"`
}

type LifeCycle 

type LifeCycle struct {
	// 工作空间首次初始化时执行
	Init []*LifeCycleCommand `json:"Init,omitnil,omitempty" name:"Init"`

	// 每次工作空间启动时执行
	Start []*LifeCycleCommand `json:"Start,omitnil,omitempty" name:"Start"`

	// 每次工作空间关闭时执行
	Destroy []*LifeCycleCommand `json:"Destroy,omitnil,omitempty" name:"Destroy"`
}

type LifeCycleCommand 

type LifeCycleCommand struct {
	// 指令描述
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 具体命令
	Command *string `json:"Command,omitnil,omitempty" name:"Command"`
}

type ModifyWorkspaceRequest 

type ModifyWorkspaceRequest struct {
	*tchttp.BaseRequest

	// 工作空间 SpaceKey. 更新该工作空间的属性
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`

	// 工作空间名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 工作空间描述
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 工作空间规格。STANDARD: 2C4G, CALCULATION: 4C8G, PROFESSION: 8C16G. 默认是 STANDARD。
	Specs *string `json:"Specs,omitnil,omitempty" name:"Specs"`

	// 环境变量. 会被注入到工作空间中
	Envs []*Env `json:"Envs,omitnil,omitempty" name:"Envs"`

	// 预装插件. 工作空间启动时, 会自动安装这些插件
	Extensions []*string `json:"Extensions,omitnil,omitempty" name:"Extensions"`

	// 工作空间生命周期钩子.  分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段.  用户可以自定义 shell 命令.
	Lifecycle *LifeCycle `json:"Lifecycle,omitnil,omitempty" name:"Lifecycle"`
}

func NewModifyWorkspaceRequest 

func NewModifyWorkspaceRequest() (request *ModifyWorkspaceRequest)

func (*ModifyWorkspaceRequest) FromJsonString 

func (r *ModifyWorkspaceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyWorkspaceRequest) ToJsonString 

func (r *ModifyWorkspaceRequest) ToJsonString() string

type ModifyWorkspaceRequestParams 

type ModifyWorkspaceRequestParams struct {
	// 工作空间 SpaceKey. 更新该工作空间的属性
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`

	// 工作空间名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 工作空间描述
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 工作空间规格。STANDARD: 2C4G, CALCULATION: 4C8G, PROFESSION: 8C16G. 默认是 STANDARD。
	Specs *string `json:"Specs,omitnil,omitempty" name:"Specs"`

	// 环境变量. 会被注入到工作空间中
	Envs []*Env `json:"Envs,omitnil,omitempty" name:"Envs"`

	// 预装插件. 工作空间启动时, 会自动安装这些插件
	Extensions []*string `json:"Extensions,omitnil,omitempty" name:"Extensions"`

	// 工作空间生命周期钩子.  分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段.  用户可以自定义 shell 命令.
	Lifecycle *LifeCycle `json:"Lifecycle,omitnil,omitempty" name:"Lifecycle"`
}

Predefined struct for user

type ModifyWorkspaceResponse 

type ModifyWorkspaceResponse struct {
	*tchttp.BaseResponse
	Response *ModifyWorkspaceResponseParams `json:"Response"`
}

func NewModifyWorkspaceResponse 

func NewModifyWorkspaceResponse() (response *ModifyWorkspaceResponse)

func (*ModifyWorkspaceResponse) FromJsonString 

func (r *ModifyWorkspaceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ModifyWorkspaceResponse) ToJsonString 

func (r *ModifyWorkspaceResponse) ToJsonString() string

type ModifyWorkspaceResponseParams 

type ModifyWorkspaceResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RemoveWorkspaceRequest 

type RemoveWorkspaceRequest struct {
	*tchttp.BaseRequest

	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`
}

func NewRemoveWorkspaceRequest 

func NewRemoveWorkspaceRequest() (request *RemoveWorkspaceRequest)

func (*RemoveWorkspaceRequest) FromJsonString 

func (r *RemoveWorkspaceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RemoveWorkspaceRequest) ToJsonString 

func (r *RemoveWorkspaceRequest) ToJsonString() string

type RemoveWorkspaceRequestParams 

type RemoveWorkspaceRequestParams struct {
	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`
}

Predefined struct for user

type RemoveWorkspaceResponse 

type RemoveWorkspaceResponse struct {
	*tchttp.BaseResponse
	Response *RemoveWorkspaceResponseParams `json:"Response"`
}

func NewRemoveWorkspaceResponse 

func NewRemoveWorkspaceResponse() (response *RemoveWorkspaceResponse)

func (*RemoveWorkspaceResponse) FromJsonString 

func (r *RemoveWorkspaceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RemoveWorkspaceResponse) ToJsonString 

func (r *RemoveWorkspaceResponse) ToJsonString() string

type RemoveWorkspaceResponseParams 

type RemoveWorkspaceResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RunWorkspaceRequest 

type RunWorkspaceRequest struct {
	*tchttp.BaseRequest

	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`
}

func NewRunWorkspaceRequest 

func NewRunWorkspaceRequest() (request *RunWorkspaceRequest)

func (*RunWorkspaceRequest) FromJsonString 

func (r *RunWorkspaceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RunWorkspaceRequest) ToJsonString 

func (r *RunWorkspaceRequest) ToJsonString() string

type RunWorkspaceRequestParams 

type RunWorkspaceRequestParams struct {
	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`
}

Predefined struct for user

type RunWorkspaceResponse 

type RunWorkspaceResponse struct {
	*tchttp.BaseResponse
	Response *RunWorkspaceResponseParams `json:"Response"`
}

func NewRunWorkspaceResponse 

func NewRunWorkspaceResponse() (response *RunWorkspaceResponse)

func (*RunWorkspaceResponse) FromJsonString 

func (r *RunWorkspaceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*RunWorkspaceResponse) ToJsonString 

func (r *RunWorkspaceResponse) ToJsonString() string

type RunWorkspaceResponseParams 

type RunWorkspaceResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type StopWorkspaceRequest 

type StopWorkspaceRequest struct {
	*tchttp.BaseRequest

	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`
}

func NewStopWorkspaceRequest 

func NewStopWorkspaceRequest() (request *StopWorkspaceRequest)

func (*StopWorkspaceRequest) FromJsonString 

func (r *StopWorkspaceRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StopWorkspaceRequest) ToJsonString 

func (r *StopWorkspaceRequest) ToJsonString() string

type StopWorkspaceRequestParams 

type StopWorkspaceRequestParams struct {
	// 工作空间 SpaceKey
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`
}

Predefined struct for user

type StopWorkspaceResponse 

type StopWorkspaceResponse struct {
	*tchttp.BaseResponse
	Response *StopWorkspaceResponseParams `json:"Response"`
}

func NewStopWorkspaceResponse 

func NewStopWorkspaceResponse() (response *StopWorkspaceResponse)

func (*StopWorkspaceResponse) FromJsonString 

func (r *StopWorkspaceResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*StopWorkspaceResponse) ToJsonString 

func (r *StopWorkspaceResponse) ToJsonString() string

type StopWorkspaceResponseParams 

type StopWorkspaceResponseParams struct {
	// 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type WorkspaceStatusInfo 

type WorkspaceStatusInfo struct {
	// 工作空间 ID
	Id *int64 `json:"Id,omitnil,omitempty" name:"Id"`

	// 工作空间名称
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`

	// 工作空间标识
	SpaceKey *string `json:"SpaceKey,omitnil,omitempty" name:"SpaceKey"`

	// 工作空间状态
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// CPU数量
	Cpu *int64 `json:"Cpu,omitnil,omitempty" name:"Cpu"`

	// 内存
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 工作空间图标
	// 注意：此字段可能返回 null，表示取不到有效值。
	Icon *string `json:"Icon,omitnil,omitempty" name:"Icon"`

	// 工作空间状态, 异常原因
	// 注意：此字段可能返回 null，表示取不到有效值。
	StatusReason *string `json:"StatusReason,omitnil,omitempty" name:"StatusReason"`

	// 工作空间描述
	// 注意：此字段可能返回 null，表示取不到有效值。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 工作空间类型
	// 注意：此字段可能返回 null，表示取不到有效值。
	WorkspaceType *string `json:"WorkspaceType,omitnil,omitempty" name:"WorkspaceType"`

	// Git 仓库 HTTPS 地址
	// 注意：此字段可能返回 null，表示取不到有效值。
	VersionControlUrl *string `json:"VersionControlUrl,omitnil,omitempty" name:"VersionControlUrl"`

	// Git 仓库引用。指定分支使用 /refs/heads/{分支名}, 指定 Tag 用 /refs/tags/{Tag名}
	// 注意：此字段可能返回 null，表示取不到有效值。
	VersionControlRef *string `json:"VersionControlRef,omitnil,omitempty" name:"VersionControlRef"`

	// 最后操作时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	LastOpsDate *string `json:"LastOpsDate,omitnil,omitempty" name:"LastOpsDate"`

	// 创建时间
	// 注意：此字段可能返回 null，表示取不到有效值。
	CreateDate *string `json:"CreateDate,omitnil,omitempty" name:"CreateDate"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.