tencentcloud-sdk-nodejs-cloudstudio 4.0.623 → 4.0.624

package/src/services/cloudstudio/v20230508/cloudstudio_client.ts

@@ -0,0 +1,144 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common"
+import {
+  DescribeConfigRequest,
+  DescribeWorkspacesRequest,
+  Env,
+  RunWorkspaceRequest,
+  CreateWorkspaceTokenResponse,
+  GitRepository,
+  CreateWorkspaceTokenRequest,
+  CreateWorkspaceRequest,
+  RunWorkspaceResponse,
+  StopWorkspaceResponse,
+  RemoveWorkspaceResponse,
+  RemoveWorkspaceRequest,
+  LifeCycleCommand,
+  StopWorkspaceRequest,
+  WorkspaceStatusInfo,
+  LifeCycle,
+  ModifyWorkspaceResponse,
+  CreateWorkspaceResponse,
+  Image,
+  DescribeConfigResponse,
+  DescribeImagesRequest,
+  DescribeWorkspacesResponse,
+  ModifyWorkspaceRequest,
+  DescribeImagesResponse,
+} from "./cloudstudio_models"
+
+/**
+ * cloudstudio client
+ * @class
+ */
+export class Client extends TencentCloudCommon.AbstractClient {
+  constructor(clientConfig: TencentCloudCommon.ClientConfig) {
+    super("cloudstudio.tencentcloudapi.com", "2023-05-08", clientConfig)
+  }
+
+  /**
+   * 获取用户配置
+   */
+  async DescribeConfig(
+    req: DescribeConfigRequest,
+    cb?: (error: string, rep: DescribeConfigResponse) => void
+  ): Promise<DescribeConfigResponse> {
+    return this.request("DescribeConfig", req, cb)
+  }
+
+  /**
+   * 修改工作空间
+   */
+  async ModifyWorkspace(
+    req: ModifyWorkspaceRequest,
+    cb?: (error: string, rep: ModifyWorkspaceResponse) => void
+  ): Promise<ModifyWorkspaceResponse> {
+    return this.request("ModifyWorkspace", req, cb)
+  }
+
+  /**
+   * 获取用户工作空间列表
+   */
+  async DescribeWorkspaces(
+    req: DescribeWorkspacesRequest,
+    cb?: (error: string, rep: DescribeWorkspacesResponse) => void
+  ): Promise<DescribeWorkspacesResponse> {
+    return this.request("DescribeWorkspaces", req, cb)
+  }
+
+  /**
+   * 获取基础镜像列表
+   */
+  async DescribeImages(
+    req?: DescribeImagesRequest,
+    cb?: (error: string, rep: DescribeImagesResponse) => void
+  ): Promise<DescribeImagesResponse> {
+    return this.request("DescribeImages", req, cb)
+  }
+
+  /**
+   * 创建工作空间
+   */
+  async CreateWorkspace(
+    req: CreateWorkspaceRequest,
+    cb?: (error: string, rep: CreateWorkspaceResponse) => void
+  ): Promise<CreateWorkspaceResponse> {
+    return this.request("CreateWorkspace", req, cb)
+  }
+
+  /**
+   * 为工作空间创建临时访问凭证，重复调用会创建新的 Token，旧的 Token 将会自动失效
+   */
+  async CreateWorkspaceToken(
+    req: CreateWorkspaceTokenRequest,
+    cb?: (error: string, rep: CreateWorkspaceTokenResponse) => void
+  ): Promise<CreateWorkspaceTokenResponse> {
+    return this.request("CreateWorkspaceToken", req, cb)
+  }
+
+  /**
+   * 删除工作空间
+   */
+  async RemoveWorkspace(
+    req: RemoveWorkspaceRequest,
+    cb?: (error: string, rep: RemoveWorkspaceResponse) => void
+  ): Promise<RemoveWorkspaceResponse> {
+    return this.request("RemoveWorkspace", req, cb)
+  }
+
+  /**
+   * 停止运行空间
+   */
+  async StopWorkspace(
+    req: StopWorkspaceRequest,
+    cb?: (error: string, rep: StopWorkspaceResponse) => void
+  ): Promise<StopWorkspaceResponse> {
+    return this.request("StopWorkspace", req, cb)
+  }
+
+  /**
+   * 运行空间
+   */
+  async RunWorkspace(
+    req: RunWorkspaceRequest,
+    cb?: (error: string, rep: RunWorkspaceResponse) => void
+  ): Promise<RunWorkspaceResponse> {
+    return this.request("RunWorkspace", req, cb)
+  }
+}

package/src/services/cloudstudio/v20230508/cloudstudio_models.ts

@@ -0,0 +1,424 @@
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * DescribeConfig请求参数结构体
+ */
+export interface DescribeConfigRequest {
+  /**
+   * 配置名称
+   */
+  Name: string
+}
+
+/**
+ * DescribeWorkspaces请求参数结构体
+ */
+export interface DescribeWorkspacesRequest {
+  /**
+   * 工作空间名称过滤条件
+   */
+  Name?: string
+}
+
+/**
+ * 环境变量
+ */
+export interface Env {
+  /**
+   * 环境变量 key
+   */
+  Name: string
+  /**
+   * 环境变量 value
+   */
+  Value: string
+}
+
+/**
+ * RunWorkspace请求参数结构体
+ */
+export interface RunWorkspaceRequest {
+  /**
+   * 工作空间 SpaceKey
+   */
+  SpaceKey: string
+}
+
+/**
+ * CreateWorkspaceToken返回参数结构体
+ */
+export interface CreateWorkspaceTokenResponse {
+  /**
+   * 访问工作空间临时凭证
+   */
+  Token?: string
+  /**
+   * token 过期时间
+   */
+  ExpiredTime?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * Git 仓库
+ */
+export interface GitRepository {
+  /**
+   * Git 仓库地址
+   */
+  Url: string
+  /**
+   * Git 仓库分支名或 Tag 名
+   */
+  Branch?: string
+}
+
+/**
+ * CreateWorkspaceToken请求参数结构体
+ */
+export interface CreateWorkspaceTokenRequest {
+  /**
+   * 工作空间 SpaceKey
+   */
+  SpaceKey?: string
+  /**
+   * token过期时间，单位是秒，默认 3600
+   */
+  TokenExpiredLimitSec?: number
+}
+
+/**
+ * CreateWorkspace请求参数结构体
+ */
+export interface CreateWorkspaceRequest {
+  /**
+   * 工作空间名称
+   */
+  Name: string
+  /**
+   * 工作空间描述
+   */
+  Description?: string
+  /**
+   * 工作空间规格。Standard: 2C4G, Calculation: 4C8G, Profession: 8C16G. 默认是 Standard。
+   */
+  Specs?: string
+  /**
+   * 工作空间基础镜像名称, 默认会使用 All In One 镜像
+   */
+  Image?: string
+  /**
+   * Git 仓库. 工作空间启动时会自动克隆该仓库
+   */
+  Repository?: GitRepository
+  /**
+   * 环境变量. 会被注入到工作空间中
+   */
+  Envs?: Array<Env>
+  /**
+   * 预装插件. 工作空间启动时, 会自动安装这些插件
+   */
+  Extensions?: Array<string>
+  /**
+   * 工作空间生命周期钩子.  分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段.  用户可以自定义 shell 命令.
+   */
+  Lifecycle?: LifeCycle
+}
+
+/**
+ * RunWorkspace返回参数结构体
+ */
+export interface RunWorkspaceResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * StopWorkspace返回参数结构体
+ */
+export interface StopWorkspaceResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * RemoveWorkspace返回参数结构体
+ */
+export interface RemoveWorkspaceResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * RemoveWorkspace请求参数结构体
+ */
+export interface RemoveWorkspaceRequest {
+  /**
+   * 工作空间 SpaceKey
+   */
+  SpaceKey: string
+}
+
+/**
+ * 工作空间生命周期执行指令
+ */
+export interface LifeCycleCommand {
+  /**
+   * 指令描述
+   */
+  Name: string
+  /**
+   * 具体命令
+   */
+  Command: string
+}
+
+/**
+ * StopWorkspace请求参数结构体
+ */
+export interface StopWorkspaceRequest {
+  /**
+   * 工作空间 SpaceKey
+   */
+  SpaceKey: string
+}
+
+/**
+ * 获取用户工作空间返回信息
+ */
+export interface WorkspaceStatusInfo {
+  /**
+   * 工作空间 ID
+   */
+  Id: number
+  /**
+   * 工作空间名称
+   */
+  Name: string
+  /**
+   * 工作空间标识
+   */
+  SpaceKey: string
+  /**
+   * 工作空间状态
+   */
+  Status: string
+  /**
+   * CPU数量
+   */
+  Cpu: number
+  /**
+   * 内存
+   */
+  Memory: number
+  /**
+   * 工作空间图标
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Icon?: string
+  /**
+   * 工作空间状态, 异常原因
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  StatusReason?: string
+  /**
+   * 工作空间描述
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Description: string
+  /**
+   * 工作空间类型
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  WorkspaceType?: string
+  /**
+   * Git 仓库 HTTPS 地址
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  VersionControlUrl: string
+  /**
+   * Git 仓库引用。指定分支使用 /refs/heads/{分支名}, 指定 Tag 用 /refs/tags/{Tag名}
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  VersionControlRef: string
+  /**
+   * 最后操作时间
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  LastOpsDate: string
+  /**
+   * 创建时间
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  CreateDate: string
+}
+
+/**
+ * 工作空间生命周期自动执行脚本
+ */
+export interface LifeCycle {
+  /**
+   * 工作空间首次初始化时执行
+   */
+  Init?: Array<LifeCycleCommand>
+  /**
+   * 每次工作空间启动时执行
+   */
+  Start?: Array<LifeCycleCommand>
+  /**
+   * 每次工作空间关闭时执行
+   */
+  Destroy?: Array<LifeCycleCommand>
+}
+
+/**
+ * ModifyWorkspace返回参数结构体
+ */
+export interface ModifyWorkspaceResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateWorkspace返回参数结构体
+ */
+export interface CreateWorkspaceResponse {
+  /**
+   * 工作空间 SpaceKey
+   */
+  SpaceKey?: string
+  /**
+   * 工作空间名称
+   */
+  Name?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * 基础镜像
+ */
+export interface Image {
+  /**
+   * 镜像名称
+   */
+  Name?: string
+  /**
+   * 镜像仓库
+   */
+  Repository?: string
+  /**
+   * tag 列表
+   */
+  Tags?: Array<string>
+}
+
+/**
+ * DescribeConfig返回参数结构体
+ */
+export interface DescribeConfigResponse {
+  /**
+   * 配置值
+注意：此字段可能返回 null，表示取不到有效值。
+   */
+  Data?: string
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeImages请求参数结构体
+ */
+export type DescribeImagesRequest = null
+
+/**
+ * DescribeWorkspaces返回参数结构体
+ */
+export interface DescribeWorkspacesResponse {
+  /**
+   * 工作空间列表
+   */
+  Data?: Array<WorkspaceStatusInfo>
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * ModifyWorkspace请求参数结构体
+ */
+export interface ModifyWorkspaceRequest {
+  /**
+   * 工作空间 SpaceKey. 更新该工作空间的属性
+   */
+  SpaceKey: string
+  /**
+   * 工作空间名称
+   */
+  Name?: string
+  /**
+   * 工作空间描述
+   */
+  Description?: string
+  /**
+   * 工作空间规格。STANDARD: 2C4G, CALCULATION: 4C8G, PROFESSION: 8C16G. 默认是 STANDARD。
+   */
+  Specs?: string
+  /**
+   * 环境变量. 会被注入到工作空间中
+   */
+  Envs?: Array<Env>
+  /**
+   * 预装插件. 工作空间启动时, 会自动安装这些插件
+   */
+  Extensions?: Array<string>
+  /**
+   * 工作空间生命周期钩子.  分为三个阶段 init, start, destroy. 分别表示工作空间数据初始化阶段, 工作空间启动阶段, 工作空间关闭阶段.  用户可以自定义 shell 命令.
+   */
+  Lifecycle?: LifeCycle
+}
+
+/**
+ * DescribeImages返回参数结构体
+ */
+export interface DescribeImagesResponse {
+  /**
+   * 镜像列表
+   */
+  Images?: Array<Image>
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}

package/src/services/cloudstudio/v20230508/index.ts

@@ -0,0 +1,6 @@
+import * as Models from "./cloudstudio_models"
+import { Client } from "./cloudstudio_client"
+export const v20230508 = {
+  Client: Client,
+  Models: Models,
+}

package/tencentcloud/services/cloudstudio/index.d.ts

@@ -1,4 +1,8 @@
 export declare const cloudstudio: {
+    v20230508: {
+        Client: typeof import("./v20230508/cloudstudio_client").Client;
+        Models: typeof import("./v20230508/cloudstudio_models");
+    };
     v20210524: {
         Client: typeof import("./v20210524/cloudstudio_client").Client;
         Models: typeof import("./v20210524/cloudstudio_models");

package/tencentcloud/services/cloudstudio/index.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cloudstudio = void 0;
+const v20230508_1 = require("./v20230508");
 const v20210524_1 = require("./v20210524");
 exports.cloudstudio = {
+    v20230508: v20230508_1.v20230508,
     v20210524: v20210524_1.v20210524,
 };

package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_client.d.ts

@@ -0,0 +1,45 @@
+import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
+import { DescribeConfigRequest, DescribeWorkspacesRequest, RunWorkspaceRequest, CreateWorkspaceTokenResponse, CreateWorkspaceTokenRequest, CreateWorkspaceRequest, RunWorkspaceResponse, StopWorkspaceResponse, RemoveWorkspaceResponse, RemoveWorkspaceRequest, StopWorkspaceRequest, ModifyWorkspaceResponse, CreateWorkspaceResponse, DescribeConfigResponse, DescribeImagesRequest, DescribeWorkspacesResponse, ModifyWorkspaceRequest, DescribeImagesResponse } from "./cloudstudio_models";
+/**
+ * cloudstudio client
+ * @class
+ */
+export declare class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig: TencentCloudCommon.ClientConfig);
+    /**
+     * 获取用户配置
+     */
+    DescribeConfig(req: DescribeConfigRequest, cb?: (error: string, rep: DescribeConfigResponse) => void): Promise<DescribeConfigResponse>;
+    /**
+     * 修改工作空间
+     */
+    ModifyWorkspace(req: ModifyWorkspaceRequest, cb?: (error: string, rep: ModifyWorkspaceResponse) => void): Promise<ModifyWorkspaceResponse>;
+    /**
+     * 获取用户工作空间列表
+     */
+    DescribeWorkspaces(req: DescribeWorkspacesRequest, cb?: (error: string, rep: DescribeWorkspacesResponse) => void): Promise<DescribeWorkspacesResponse>;
+    /**
+     * 获取基础镜像列表
+     */
+    DescribeImages(req?: DescribeImagesRequest, cb?: (error: string, rep: DescribeImagesResponse) => void): Promise<DescribeImagesResponse>;
+    /**
+     * 创建工作空间
+     */
+    CreateWorkspace(req: CreateWorkspaceRequest, cb?: (error: string, rep: CreateWorkspaceResponse) => void): Promise<CreateWorkspaceResponse>;
+    /**
+     * 为工作空间创建临时访问凭证，重复调用会创建新的 Token，旧的 Token 将会自动失效
+     */
+    CreateWorkspaceToken(req: CreateWorkspaceTokenRequest, cb?: (error: string, rep: CreateWorkspaceTokenResponse) => void): Promise<CreateWorkspaceTokenResponse>;
+    /**
+     * 删除工作空间
+     */
+    RemoveWorkspace(req: RemoveWorkspaceRequest, cb?: (error: string, rep: RemoveWorkspaceResponse) => void): Promise<RemoveWorkspaceResponse>;
+    /**
+     * 停止运行空间
+     */
+    StopWorkspace(req: StopWorkspaceRequest, cb?: (error: string, rep: StopWorkspaceResponse) => void): Promise<StopWorkspaceResponse>;
+    /**
+     * 运行空间
+     */
+    RunWorkspace(req: RunWorkspaceRequest, cb?: (error: string, rep: RunWorkspaceResponse) => void): Promise<RunWorkspaceResponse>;
+}