@ucloud-sdks/ucloud-sdk-js 0.0.5 → 0.2.1

package/lib/services/uphost/index.d.ts

@@ -15,6 +15,12 @@ export default class UPHostClient extends Client {
      * See also: https://docs.ucloud.cn/api/uphost-api/create_phost
      */
     createPHost(request?: CreatePHostRequest): Promise<CreatePHostResponse>;
+    /**
+     * CreatePHostImage - 创建裸金属2.0用户自定义镜像
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/create_phost_image
+     */
+    createPHostImage(request?: CreatePHostImageRequest): Promise<CreatePHostImageResponse>;
     /**
      * DescribeBaremetalMachineType - 获取裸金属机型的详细描述信息
      *
@@ -57,6 +63,12 @@ export default class UPHostClient extends Client {
      * See also: https://docs.ucloud.cn/api/uphost-api/get_phost_price
      */
     getPHostPrice(request?: GetPHostPriceRequest): Promise<GetPHostPriceResponse>;
+    /**
+     * ModifyPHostImageInfo - 修改自定义镜像名称和备注
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/modify_phost_image_info
+     */
+    modifyPHostImageInfo(request?: ModifyPHostImageInfoRequest): Promise<ModifyPHostImageInfoResponse>;
     /**
      * ModifyPHostInfo - 更改物理机信息
      *
@@ -99,12 +111,24 @@ export default class UPHostClient extends Client {
      * See also: https://docs.ucloud.cn/api/uphost-api/start_phost
      */
     startPHost(request?: StartPHostRequest): Promise<StartPHostResponse>;
+    /**
+     * StopPHost - 关闭物理机
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/stop_phost
+     */
+    stopPHost(request?: StopPHostRequest): Promise<StopPHostResponse>;
     /**
      * TerminatePHost - 删除物理云主机
      *
      * See also: https://docs.ucloud.cn/api/uphost-api/terminate_phost
      */
     terminatePHost(request?: TerminatePHostRequest): Promise<TerminatePHostResponse>;
+    /**
+     * TerminatePHostImage - 删除裸金属2.0用户自定义镜像
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/terminate_phost_image
+     */
+    terminatePHostImage(request?: TerminatePHostImageRequest): Promise<TerminatePHostImageResponse>;
 }
 /**
  * CreatePHost - 指定数据中心，根据资源使用量创建指定数量的UPHost物理云主机实例。
@@ -205,12 +229,42 @@ export interface CreatePHostResponse {
      */
     PHostId?: string[];
 }
+/**
+ * CreatePHostImage - 创建裸金属2.0用户自定义镜像
+ */
+export interface CreatePHostImageRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * UPHost实例ID
+     */
+    PHostId: string;
+    /**
+     * 镜像名称
+     */
+    ImageName: string;
+    /**
+     * 镜像描述
+     */
+    ImageDescription?: string;
+}
+/**
+ * CreatePHostImage - 创建裸金属2.0用户自定义镜像
+ */
+export interface CreatePHostImageResponse {
+    /**
+     * 镜像ID
+     */
+    ImageId: string;
+}
 /**
  * DescribeBaremetalMachineType - 获取裸金属机型的详细描述信息
  */
 export interface DescribeBaremetalMachineTypeRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
@@ -223,16 +277,72 @@ export interface DescribeBaremetalMachineTypeRequest {
  */
 export interface DescribeBaremetalMachineTypeResponse {
     /**
-     * 机型列表，模型：PHostMachineTypeSet
+     * 机型列表，模型：PHostCloudMachineTypeSet
      */
-    MachineTypes?: string;
+    MachineTypes?: {
+        /**
+         * 物理云主机机型别名，全网唯一。
+         */
+        Type: string;
+        /**
+         * CPU信息
+         */
+        CPU?: {
+            /**
+             * CPU型号
+             */
+            Model?: string;
+            /**
+             * CPU主频
+             */
+            Frequence?: number;
+            /**
+             * CPU个数
+             */
+            Count?: number;
+            /**
+             * CPU核数
+             */
+            CoreCount?: number;
+        };
+        /**
+         * 内存大小，单位MB
+         */
+        Memory?: number;
+        /**
+         * 其他组件信息
+         */
+        Components?: {
+            /**
+             * 组件名称
+             */
+            Name?: string;
+            /**
+             * 组件数量
+             */
+            Count?: number;
+        };
+        /**
+         * 集群库存信息
+         */
+        Clusters?: {
+            /**
+             * 集群名。枚举值：千兆网络集群：1G；万兆网络集群：10G；智能网卡网络：25G；
+             */
+            Name?: string;
+            /**
+             * 库存状态。枚举值：有库存：Available；无库存：SoldOut
+             */
+            StockStatus?: string;
+        }[];
+    }[];
 }
 /**
  * DescribePHost - 获取物理机详细信息
  */
 export interface DescribePHostRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone?: string;
     /**
@@ -251,6 +361,10 @@ export interface DescribePHostRequest {
      * 要挂载的云盘id，过滤返回能被UDiskId挂载的云主机。目前主要针对rssd云盘使用
      */
     UDiskIdForAttachment?: string;
+    /**
+     * ULB使用参数，获取同VPC下机器信息。
+     */
+    VPCId?: string;
 }
 /**
  * DescribePHost - 获取物理机详细信息
@@ -277,7 +391,7 @@ export interface DescribePHostResponse {
          */
         SN?: string;
         /**
-         * 物理云主机状态。枚举值：\\ > 初始化:Initializing; \\ > 启动中：Starting； \\ > 运行中：Running；\\ > 关机中：Stopping； \\ > 安装失败：InstallFailed； \\ > 重启中：Rebooting；\\ > 关机：Stopped；
+         * 物理云主机状态。枚举值：\\ > 初始化:Initializing; \\ > 启动中：Starting； \\ > 运行中：Running；\\ > 关机中：Stopping； \\ > 安装失败：InstallFailed； \\ > 重启中：Rebooting；\\ > 关机：Stopped； \\ > 迁移中(裸金属云盘)：Migrating
          */
         PMStatus?: string;
         /**
@@ -346,7 +460,7 @@ export interface DescribePHostResponse {
             CoreCount?: number;
         };
         /**
-         * 磁盘信息，见 PHostDiskSet
+         * 磁盘信息，见 PHostDescDiskSet
          */
         DiskSet?: {
             /**
@@ -450,11 +564,11 @@ export interface DescribePHostResponse {
  */
 export interface DescribePHostImageRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
-     * 镜像类别，枚举值，Base是基础镜像；
+     * 镜像类别，枚举值，Base是基础镜像；Custom是自制镜像。
      */
     ImageType?: string;
     /**
@@ -510,6 +624,26 @@ export interface DescribePHostImageResponse {
          * 当前版本
          */
         Version?: string;
+        /**
+         * 枚举值：Base=>基础镜像，Custom=>自制镜像。
+         */
+        ImageType?: string;
+        /**
+         * 裸金属2.0参数。镜像创建时间。
+         */
+        CreateTime?: number;
+        /**
+         * 裸金属2.0参数。镜像当前状态。
+         */
+        State?: string;
+        /**
+         * 裸金属2.0参数。镜像大小。
+         */
+        ImageSize?: number;
+        /**
+         * 镜像描述
+         */
+        ImageDescription?: string;
     }[];
 }
 /**
@@ -517,7 +651,7 @@ export interface DescribePHostImageResponse {
  */
 export interface DescribePHostMachineTypeRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
@@ -586,18 +720,6 @@ export interface DescribePHostMachineTypeResponse {
              * 磁盘IO性能，单位MB/s（待废弃）
              */
             IOCap?: number;
-            /**
-             * 裸金属机型参数：磁盘盘符
-             */
-            Drive?: string;
-            /**
-             * 裸金属机型参数：磁盘ID
-             */
-            DiskId?: string;
-            /**
-             * 裸金属机型参数：是否是启动盘。True/False
-             */
-            IsBoot?: string;
         }[];
         /**
          * 其他组件信息
@@ -610,7 +732,7 @@ export interface DescribePHostMachineTypeResponse {
             /**
              * 组件数量
              */
-            Count?: string;
+            Count?: number;
         };
         /**
          * 集群库存信息
@@ -705,7 +827,7 @@ export interface GetPHostDiskUpgradePriceResponse {
  */
 export interface GetPHostPriceRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone?: string;
     /**
@@ -772,6 +894,36 @@ export interface GetPHostPriceResponse {
         OriginalPrice?: number;
     }[];
 }
+/**
+ * ModifyPHostImageInfo - 修改自定义镜像名称和备注
+ */
+export interface ModifyPHostImageInfoRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 镜像ID
+     */
+    ImageId: string;
+    /**
+     * 镜像名称
+     */
+    Name?: string;
+    /**
+     * 备注
+     */
+    Remark?: string;
+}
+/**
+ * ModifyPHostImageInfo - 修改自定义镜像名称和备注
+ */
+export interface ModifyPHostImageInfoResponse {
+    /**
+     * 镜像ID
+     */
+    ImageId?: string;
+}
 /**
  * ModifyPHostInfo - 更改物理机信息
  */
@@ -935,7 +1087,7 @@ export interface ResetPHostPasswordResponse {
  */
 export interface ResizePHostAttachedDiskRequest {
     /**
-     * 可用区。参见 [可用区列表](../summary/regionlist.html)
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
      */
     Zone: string;
     /**
@@ -958,7 +1110,7 @@ export interface ResizePHostAttachedDiskResponse {
     /**
      * 改配成功的磁盘id
      */
-    DiskId?: string;
+    UDiskId?: string;
 }
 /**
  * StartPHost - 启动物理机
@@ -982,6 +1134,28 @@ export interface StartPHostResponse {
      */
     PHostId?: string;
 }
+/**
+ * StopPHost - 关闭物理机
+ */
+export interface StopPHostRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone?: string;
+    /**
+     * PHost资源ID
+     */
+    PHostId: string;
+}
+/**
+ * StopPHost - 关闭物理机
+ */
+export interface StopPHostResponse {
+    /**
+     * PHost 的资源ID
+     */
+    PHostId: string;
+}
 /**
  * TerminatePHost - 删除物理云主机
  */
@@ -1012,3 +1186,25 @@ export interface TerminatePHostResponse {
      */
     PHostId?: string;
 }
+/**
+ * TerminatePHostImage - 删除裸金属2.0用户自定义镜像
+ */
+export interface TerminatePHostImageRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 自制镜像ID
+     */
+    ImageId: string;
+}
+/**
+ * TerminatePHostImage - 删除裸金属2.0用户自定义镜像
+ */
+export interface TerminatePHostImageResponse {
+    /**
+     * 自制镜像ID
+     */
+    ImageId: string;
+}

package/lib/services/uphost/index.js

@@ -21,6 +21,15 @@ class UPHostClient extends client_1.default {
         const args = Object.assign({ Action: 'CreatePHost' }, (request || {}));
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
+    /**
+     * CreatePHostImage - 创建裸金属2.0用户自定义镜像
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/create_phost_image
+     */
+    createPHostImage(request) {
+        const args = Object.assign({ Action: 'CreatePHostImage' }, (request || {}));
+        return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
+    }
     /**
      * DescribeBaremetalMachineType - 获取裸金属机型的详细描述信息
      *
@@ -84,6 +93,15 @@ class UPHostClient extends client_1.default {
         const args = Object.assign({ Action: 'GetPHostPrice' }, (request || {}));
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
+    /**
+     * ModifyPHostImageInfo - 修改自定义镜像名称和备注
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/modify_phost_image_info
+     */
+    modifyPHostImageInfo(request) {
+        const args = Object.assign({ Action: 'ModifyPHostImageInfo' }, (request || {}));
+        return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
+    }
     /**
      * ModifyPHostInfo - 更改物理机信息
      *
@@ -147,6 +165,15 @@ class UPHostClient extends client_1.default {
         const args = Object.assign({ Action: 'StartPHost' }, (request || {}));
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
+    /**
+     * StopPHost - 关闭物理机
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/stop_phost
+     */
+    stopPHost(request) {
+        const args = Object.assign({ Action: 'StopPHost' }, (request || {}));
+        return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
+    }
     /**
      * TerminatePHost - 删除物理云主机
      *
@@ -156,5 +183,14 @@ class UPHostClient extends client_1.default {
         const args = Object.assign({ Action: 'TerminatePHost' }, (request || {}));
         return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
     }
+    /**
+     * TerminatePHostImage - 删除裸金属2.0用户自定义镜像
+     *
+     * See also: https://docs.ucloud.cn/api/uphost-api/terminate_phost_image
+     */
+    terminatePHostImage(request) {
+        const args = Object.assign({ Action: 'TerminatePHostImage' }, (request || {}));
+        return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
+    }
 }
 exports.default = UPHostClient;

package/lib/services/usms/index.d.ts

@@ -80,6 +80,10 @@ export default class USMSClient extends Client {
  * CreateUSMSSignature - 调用接口CreateUSMSSignature申请短信签名
  */
 export interface CreateUSMSSignatureRequest {
+    /**
+     * 签名内容
+     */
+    SigContent: string;
     /**
      * 签名类型，说明如下：0-公司或企业的全称或简称；1-App应用的全称或简称；2-工信部备案网站的全称或简称；3-公众号或小程序的全称或简称；4-商标名的全称或简称；5-政府/机关事业单位/其他单位的全称或简称；
      */
@@ -142,6 +146,14 @@ export interface CreateUSMSTemplateRequest {
      * 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。
      */
     Remark?: string;
+    /**
+     * 当Purpose为3时，也即会员推广类短信模板，该项必填。枚举值：TD退订、回T退订、回N退订、回TD退订、退订回T、退订回D、退订回TD、退订回复T、退订回复D、退订回复N、退订回复TD、拒收回T
+     */
+    UnsubscribeInfo?: string;
+    /**
+     * 模板变量属性说明
+     */
+    Instruction?: string;
 }
 /**
  * CreateUSMSTemplate - 调用接口CreateUSMSTemplate申请短信模板
@@ -189,7 +201,7 @@ export interface GetUSMSSendReceiptRequest {
      */
     Zone?: string;
     /**
-     * 发送短信时返回的SessionNo集合，SessionNoSet.0,SessionNoSet.1....格式
+     * 发送短信时返回的SessionNo集合，SessionNoSet.0,SessionNoSet.1....格式，单次调用集合数需控制在100个以内
      */
     SessionNoSet: string[];
 }
@@ -332,6 +344,10 @@ export interface QueryUSMSTemplateResponse {
          * 创建时间
          */
         CreateTime: number;
+        /**
+         * 模板变量属性说明
+         */
+        Instruction?: string;
     };
 }
 /**
@@ -419,7 +435,7 @@ export interface SendUSMSMessageRequest {
      */
     TemplateId: string;
     /**
-     * 模板可变参数，以数组的方式填写，举例，TempalteParams.0，TempalteParams.1，... 若模板中无可变参数，则该项可不填写；若模板中有可变参数，则该项为必填项，参数个数需与变量个数保持一致，否则无法发送；
+     * 模板可变参数，以数组的方式填写，举例，TemplateParams.0，TemplateParams.1，... 若模板中无可变参数，则该项可不填写；若模板中有可变参数，则该项为必填项，参数个数需与变量个数保持一致，否则无法发送；
      */
     TemplateParams?: string[];
     /**
@@ -427,7 +443,7 @@ export interface SendUSMSMessageRequest {
      */
     ExtendCode?: string;
     /**
-     * 自定义的业务标识ID，字符串（ 长度不能超过32 位）
+     * 自定义的业务标识ID，字符串（ 长度不能超过32 位），不支持 单引号、表情包符号等特殊字符
      */
     UserId?: string;
 }
@@ -510,6 +526,10 @@ export interface UpdateUSMSTemplateRequest {
      * 短信模板申请原因说明，字数不超过128，每个中文、符号、英文、数字等都计为1个字。
      */
     Remark?: string;
+    /**
+     * 模板变量属性说明
+     */
+    Instruction?: string;
 }
 /**
  * UpdateUSMSTemplate - 调用接口UpdateUSMSTemplate修改未通过审核的短信模板，并重新提交审核

package/lib/services/uvms/index.d.ts

@@ -0,0 +1,64 @@
+import Client from '../../core/client';
+import { ConfigOptions } from '../../core/config';
+import { CredentialOptions } from '../../core/credential';
+/**
+ * This client is used to call actions of **uvms** service
+ */
+export default class UVMSClient extends Client {
+    constructor({ config, credential, }: {
+        config: ConfigOptions;
+        credential: CredentialOptions;
+    });
+    /**
+     * SendUVMSMessage - 向指定号码拨打电话
+     *
+     * See also: https://docs.ucloud.cn/api/uvms-api/send_uvms_message
+     */
+    sendUVMSMessage(request?: SendUVMSMessageRequest): Promise<SendUVMSMessageResponse>;
+}
+/**
+ * SendUVMSMessage - 向指定号码拨打电话
+ */
+export interface SendUVMSMessageRequest {
+    /**
+     * 可用区。参见 [可用区列表](https://docs.ucloud.cn/api/summary/regionlist)
+     */
+    Zone: string;
+    /**
+     * 被叫号码，采用 E.164 标准，格式为+[国家代码][用户号码]。例如：+8613512345678， 其中前面有一个+号 ，86为国家码，13512345678为手机号
+     */
+    CalledNumber: string;
+    /**
+     * 模板 ID，在控制台审核通过的模板 ID。
+     */
+    TemplateId: string;
+    /**
+     * 模板可变参数，以数组的方式填写，举例，TemplateParams.0，TemplateParams.1，... 若模板中无可变参数，则该项可不填写；若模板中有可变参数，则该项为必填项，参数个数需与变量个数保持一致，否则无法发送；
+     */
+    TemplateParams?: string[];
+    /**
+     * 主叫号码，号码随机时不填。专属号码时传入已购买的号码，仅支持一个号码，在控制台查看已购买的号码。
+     */
+    FromNumber?: string;
+    /**
+     * 自定义的业务标识ID，字符串（ 长度不能超过32 位），不支持 单引号、表情包符号等特殊字符
+     */
+    UserId?: string;
+}
+/**
+ * SendUVMSMessage - 向指定号码拨打电话
+ */
+export interface SendUVMSMessageResponse {
+    /**
+     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 ReqUuid。
+     */
+    ReqUuid: string;
+    /**
+     * 本次提交发送语音的唯一ID，可根据该值查询本次发送详情
+     */
+    SessionNo?: string;
+    /**
+     * 	本次提交的自定义业务标识ID，仅当发送时传入有效的UserId，才返回该字段。
+     */
+    UserId?: string;
+}

package/lib/services/uvms/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const client_1 = __importDefault(require("../../core/client"));
+const request_1 = __importDefault(require("../../core/request"));
+/**
+ * This client is used to call actions of **uvms** service
+ */
+class UVMSClient extends client_1.default {
+    constructor({ config, credential, }) {
+        super({ config, credential });
+    }
+    /**
+     * SendUVMSMessage - 向指定号码拨打电话
+     *
+     * See also: https://docs.ucloud.cn/api/uvms-api/send_uvms_message
+     */
+    sendUVMSMessage(request) {
+        const args = Object.assign({ Action: 'SendUVMSMessage' }, (request || {}));
+        return this.invoke(new request_1.default(args)).then((resp) => resp.toObject());
+    }
+}
+exports.default = UVMSClient;