| 1 | /**
|
| 2 | * 初始化client对象参数类型
|
| 3 | */
|
| 4 | export interface ClientConfig {
|
| 5 | /**
|
| 6 | * @param {Credential} credential 认证信息
|
| 7 | * 必选
|
| 8 | */
|
| 9 | credential: Credential
|
| 10 | /**
|
| 11 | * @param {string} region 产品地域
|
| 12 | * 必选
|
| 13 | */
|
| 14 | region: string
|
| 15 | /**
|
| 16 | * @param {ClientProfile} profile 可选配置实例
|
| 17 | * 可选，没有特殊需求可以跳过。
|
| 18 | */
|
| 19 | profile?: ClientProfile
|
| 20 | }
|
| 21 |
|
| 22 | /**
|
| 23 | * 可选配置实例
|
| 24 | */
|
| 25 | export interface ClientProfile {
|
| 26 | /**
|
| 27 | * 签名方法 (TC3-HMAC-SHA256 HmacSHA1 HmacSHA256)
|
| 28 | * @type {string}
|
| 29 | * 非必选
|
| 30 | */
|
| 31 | signMethod?: "TC3-HMAC-SHA256" | "HmacSHA256" | "HmacSHA1"
|
| 32 | /**
|
| 33 | * http相关选项实例
|
| 34 | * @type {httpProfile}
|
| 35 | * 非必选
|
| 36 | */
|
| 37 | httpProfile?: {
|
| 38 | /**
|
| 39 | * 请求方法
|
| 40 | * @type {"POST" | "GET"}
|
| 41 | * 非必选
|
| 42 | */
|
| 43 | reqMethod?: "POST" | "GET"
|
| 44 | /**
|
| 45 | * 接入点域名，形如（cvm.ap-shanghai.tencentcloud.com）
|
| 46 | * @type {string}
|
| 47 | * 非必选
|
| 48 | */
|
| 49 | endpoint?: string
|
| 50 | /**
|
| 51 | * 协议，目前支持（https://）
|
| 52 | * @type {string}
|
| 53 | * 非必选
|
| 54 | */
|
| 55 | protocol?: string
|
| 56 | /**
|
| 57 | * 请求超时时间，默认60s
|
| 58 | * @type {number}
|
| 59 | * 非必选
|
| 60 | */
|
| 61 | reqTimeout?: number
|
| 62 | }
|
| 63 | }
|
| 64 |
|
| 65 | /**
|
| 66 | * 认证信息类
|
| 67 | */
|
| 68 | export interface Credential {
|
| 69 | /**
|
| 70 | * 腾讯云账户secretId，secretKey
|
| 71 | * 非必选，和 token 二选一
|
| 72 | */
|
| 73 | secretId?: string
|
| 74 | /**
|
| 75 | * 腾讯云账户secretKey
|
| 76 | * 非必选，和 token 二选一
|
| 77 | */
|
| 78 | secretKey?: string
|
| 79 | /**
|
| 80 | * 腾讯云账户token
|
| 81 | * 非必选，和 secretId 二选一
|
| 82 | */
|
| 83 | token?: string
|
| 84 | }
|