tenyun/types/tsw.d.ts

Promise based and chained Tencent Cloud OpenAPI client for NodeJS

/// <reference types="node" />

import { AxiosPromise, AxiosRequestConfig } from "axios";

declare interface DescribeComponentAlertObjectRequest {
}

declare interface DescribeComponentAlertObjectResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeServiceAlertObjectRequest {
}

declare interface DescribeServiceAlertObjectResponse {
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare interface DescribeTokenRequest {
  /** 命名空间 */
  Namespace: string;
}

declare interface DescribeTokenResponse {
  /** token */
  Result: string;
  /** 唯一请求 ID，每次请求都会返回。 */
  RequestId?: string;
}

declare namespace V20200924 {
  type VersionHeader = { headers: { 'X-TC-Version': '2020-09-24' } }

  /** agent安装脚本串 */
  interface AgentShell {
    /** 鉴权token */
    Token: string | null;
    /** 数据接收Ip */
    EtlIp: string | null;
    /** 数据接收port */
    EtlPort: string | null;
    /** 手动接入脚本串 */
    ByHandAccess: string | null;
    /** 自动接入脚本串 */
    ByShellAccess: string | null;
    /** SkyWalking数据接收port */
    SkyWalkingPort: string | null;
    /** Zipkin数据接收port */
    ZipkinPort: string | null;
    /** Jaeger数据接收port */
    JaegerPort: string | null;
  }

  interface DescribeAgentShellRequest {
  }

  interface DescribeAgentShellResponse {
    /** 接入信息 */
    Result: AgentShell | null;
    /** 唯一请求 ID，每次请求都会返回。 */
    RequestId?: string;
  }
}

/** {@link Tsw 微服务观测平台 TSW} */
declare interface Tsw {
  (): Versions;
  /** 获取告警对象-组件告警 {@link DescribeComponentAlertObjectRequest} {@link DescribeComponentAlertObjectResponse} */
  DescribeComponentAlertObject(data?: DescribeComponentAlertObjectRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeComponentAlertObjectResponse>;
  /** 获取告警对象-服务告警表 {@link DescribeServiceAlertObjectRequest} {@link DescribeServiceAlertObjectResponse} */
  DescribeServiceAlertObject(data?: DescribeServiceAlertObjectRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeServiceAlertObjectResponse>;
  /** 查询token {@link DescribeTokenRequest} {@link DescribeTokenResponse} */
  DescribeToken(data: DescribeTokenRequest, config?: AxiosRequestConfig): AxiosPromise<DescribeTokenResponse>;
  /** 获取服务接入信息 {@link V20200924.DescribeAgentShellRequest} {@link V20200924.DescribeAgentShellResponse} */
  DescribeAgentShell(data: V20200924.DescribeAgentShellRequest, config: AxiosRequestConfig & V20200924.VersionHeader): AxiosPromise<V20200924.DescribeAgentShellResponse>;
}

export declare type Versions = ["2021-04-12", "2020-09-24"];

export default Tsw;