UNPKG

tencentcloud-sdk-nodejs

Version:
230 lines (226 loc) 15.4 kB
import { AbstractClient } from "../../../common/abstract_client"; import { ClientConfig } from "../../../common/interface"; import { UpdateAuthorizationPolicyPriorityResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, DescribeMessageListRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DescribeSharedSubscriptionLagResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DeleteAuthenticatorRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, RegisterCaCertificateResponse, DeleteInstanceRequest, ModifyInstanceRequest, RegisterDeviceCertificateResponse, DescribeClientListResponse, DescribeMessageListResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyInstanceResponse, CreateHttpAuthenticatorResponse, ModifyInsPublicEndpointResponse, ModifyJWKSAuthenticatorResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeInsPublicEndpointsRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, ModifyHttpAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DescribeUserListResponse, ModifyTopicResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, DescribeClientListRequest, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, CreateTopicResponse, RevokedDeviceCertificateRequest, CreateAuthorizationPolicyResponse, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateInstanceRequest, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, DescribeDeviceCertificatesResponse, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeUserListRequest, DescribeCaCertificateRequest, UpdateAuthorizationPolicyPriorityRequest, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeAuthorizationPoliciesRequest, RevokedDeviceCertificateResponse, CreateHttpAuthenticatorRequest, DescribeProductSKUListRequest, DescribeTopicListResponse, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyAuthorizationPolicyRequest, DescribeSharedSubscriptionLagRequest, DeleteTopicResponse, ModifyInstanceCertBindingRequest, ModifyHttpAuthenticatorRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse } from "./mqtt_models"; /** * mqtt client * @class */ export declare class Client extends AbstractClient { constructor(clientConfig: ClientConfig); /** * 查询用户列表,Filter参数使用说明如下: 1. Username,用户名称模糊搜索 */ DescribeUserList(req: DescribeUserListRequest, cb?: (error: string, rep: DescribeUserListResponse) => void): Promise<DescribeUserListResponse>; /** * 为MQTT实例创建公网接入点 */ CreateInsPublicEndpoint(req: CreateInsPublicEndpointRequest, cb?: (error: string, rep: CreateInsPublicEndpointResponse) => void): Promise<CreateInsPublicEndpointResponse>; /** * 修改主题属性 */ ModifyTopic(req: ModifyTopicRequest, cb?: (error: string, rep: ModifyTopicResponse) => void): Promise<ModifyTopicResponse>; /** * 删除Ca证书 */ DeleteCaCertificate(req: DeleteCaCertificateRequest, cb?: (error: string, rep: DeleteCaCertificateResponse) => void): Promise<DeleteCaCertificateResponse>; /** * 失效Ca证书 */ DeactivateDeviceCertificate(req: DeactivateDeviceCertificateRequest, cb?: (error: string, rep: DeactivateDeviceCertificateResponse) => void): Promise<DeactivateDeviceCertificateResponse>; /** * 查询mqtt主题详情 */ DescribeTopic(req: DescribeTopicRequest, cb?: (error: string, rep: DescribeTopicResponse) => void): Promise<DescribeTopicResponse>; /** * 失效Ca证书 */ DeactivateCaCertificate(req: DeactivateCaCertificateRequest, cb?: (error: string, rep: DeactivateCaCertificateResponse) => void): Promise<DeactivateCaCertificateResponse>; /** * 创建一个jwks的认证 */ CreateJWTAuthenticator(req: CreateJWTAuthenticatorRequest, cb?: (error: string, rep: CreateJWTAuthenticatorResponse) => void): Promise<CreateJWTAuthenticatorResponse>; /** * 删除设备证书 */ DeleteDeviceCertificate(req: DeleteDeviceCertificateRequest, cb?: (error: string, rep: DeleteDeviceCertificateResponse) => void): Promise<DeleteDeviceCertificateResponse>; /** * 删除MQTT实例 */ DeleteInstance(req: DeleteInstanceRequest, cb?: (error: string, rep: DeleteInstanceResponse) => void): Promise<DeleteInstanceResponse>; /** * 发布 MQTT 消息到消息主题或客户端 */ PublishMessage(req: PublishMessageRequest, cb?: (error: string, rep: PublishMessageResponse) => void): Promise<PublishMessageResponse>; /** * 修改MQTT JWKS 认证器 */ ModifyJWTAuthenticator(req: ModifyJWTAuthenticatorRequest, cb?: (error: string, rep: ModifyJWTAuthenticatorResponse) => void): Promise<ModifyJWTAuthenticatorResponse>; /** * 修改MQTT JWKS 认证器 */ ModifyJWKSAuthenticator(req: ModifyJWKSAuthenticatorRequest, cb?: (error: string, rep: ModifyJWKSAuthenticatorResponse) => void): Promise<ModifyJWKSAuthenticatorResponse>; /** * 分页查询设备证书 */ DescribeDeviceCertificates(req: DescribeDeviceCertificatesRequest, cb?: (error: string, rep: DescribeDeviceCertificatesResponse) => void): Promise<DescribeDeviceCertificatesResponse>; /** * 查询MQTT实例公网接入点 */ DescribeInsPublicEndpoints(req: DescribeInsPublicEndpointsRequest, cb?: (error: string, rep: DescribeInsPublicEndpointsResponse) => void): Promise<DescribeInsPublicEndpointsResponse>; /** * 更新MQTT实例公网接入点 */ ModifyInsPublicEndpoint(req: ModifyInsPublicEndpointRequest, cb?: (error: string, rep: ModifyInsPublicEndpointResponse) => void): Promise<ModifyInsPublicEndpointResponse>; /** * 查询设备证书详情接口 */ DescribeDeviceCertificate(req: DescribeDeviceCertificateRequest, cb?: (error: string, rep: DescribeDeviceCertificateResponse) => void): Promise<DescribeDeviceCertificateResponse>; /** * 注册设备证书(仅一机一证场景生效),可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817#6cb39d46-efad-4220-8f11-2e7fab207bc8) */ RegisterDeviceCertificate(req: RegisterDeviceCertificateRequest, cb?: (error: string, rep: RegisterDeviceCertificateResponse) => void): Promise<RegisterDeviceCertificateResponse>; /** * 更新MQTT集群绑定证书 参数传空,则为删除证书 */ ModifyInstanceCertBinding(req: ModifyInstanceCertBindingRequest, cb?: (error: string, rep: ModifyInstanceCertBindingResponse) => void): Promise<ModifyInstanceCertBindingResponse>; /** * 查询MQTT实例公网接入点 */ DescribeInsVPCEndpoints(req: DescribeInsVPCEndpointsRequest, cb?: (error: string, rep: DescribeInsVPCEndpointsResponse) => void): Promise<DescribeInsVPCEndpointsResponse>; /** * 查询 MQTT 客户端详情 */ DescribeClientList(req: DescribeClientListRequest, cb?: (error: string, rep: DescribeClientListResponse) => void): Promise<DescribeClientListResponse>; /** * 获取产品售卖规格 */ DescribeProductSKUList(req?: DescribeProductSKUListRequest, cb?: (error: string, rep: DescribeProductSKUListResponse) => void): Promise<DescribeProductSKUListResponse>; /** * 查询集群下的ca证书信息 */ DescribeCaCertificates(req: DescribeCaCertificatesRequest, cb?: (error: string, rep: DescribeCaCertificatesResponse) => void): Promise<DescribeCaCertificatesResponse>; /** * 修改策略规则优先级 */ UpdateAuthorizationPolicyPriority(req: UpdateAuthorizationPolicyPriorityRequest, cb?: (error: string, rep: UpdateAuthorizationPolicyPriorityResponse) => void): Promise<UpdateAuthorizationPolicyPriorityResponse>; /** * 创建主题 */ CreateTopic(req: CreateTopicRequest, cb?: (error: string, rep: CreateTopicResponse) => void): Promise<CreateTopicResponse>; /** * 生效设备证书 */ ActivateDeviceCertificate(req: ActivateDeviceCertificateRequest, cb?: (error: string, rep: ActivateDeviceCertificateResponse) => void): Promise<ActivateDeviceCertificateResponse>; /** * 查询授权规则 */ DescribeAuthorizationPolicies(req: DescribeAuthorizationPoliciesRequest, cb?: (error: string, rep: DescribeAuthorizationPoliciesResponse) => void): Promise<DescribeAuthorizationPoliciesResponse>; /** * 获取主题列表,Filter参数使用说明如下: 1. TopicName,主题名称模糊搜索 2. TopicType,主题类型查询,支持多选,可选值:Normal,Order,Transaction,DelayScheduled */ DescribeTopicList(req: DescribeTopicListRequest, cb?: (error: string, rep: DescribeTopicListResponse) => void): Promise<DescribeTopicListResponse>; /** * 删除MQTT实例的公网接入点 */ DeleteInsPublicEndpoint(req: DeleteInsPublicEndpointRequest, cb?: (error: string, rep: DeleteInsPublicEndpointResponse) => void): Promise<DeleteInsPublicEndpointResponse>; /** * 购买新的MQTT实例 */ CreateInstance(req: CreateInstanceRequest, cb?: (error: string, rep: CreateInstanceResponse) => void): Promise<CreateInstanceResponse>; /** * 获取实例列表,Filters参数使用说明如下: 1. InstanceName, 名称模糊查询 2. InstanceId,实例ID查询 3. InstanceStatus,实例状态查询,支持多选 当使用TagFilters查询时,Filters参数失效。 */ DescribeInstanceList(req: DescribeInstanceListRequest, cb?: (error: string, rep: DescribeInstanceListResponse) => void): Promise<DescribeInstanceListResponse>; /** * 吊销设备证书 */ RevokedDeviceCertificate(req: RevokedDeviceCertificateRequest, cb?: (error: string, rep: RevokedDeviceCertificateResponse) => void): Promise<RevokedDeviceCertificateResponse>; /** * 查询实例信息 */ DescribeInstance(req: DescribeInstanceRequest, cb?: (error: string, rep: DescribeInstanceResponse) => void): Promise<DescribeInstanceResponse>; /** * 删除MQTT主题 */ DeleteTopic(req: DeleteTopicRequest, cb?: (error: string, rep: DeleteTopicResponse) => void): Promise<DeleteTopicResponse>; /** * 查询Ca证书详情接口 */ DescribeCaCertificate(req: DescribeCaCertificateRequest, cb?: (error: string, rep: DescribeCaCertificateResponse) => void): Promise<DescribeCaCertificateResponse>; /** * 创建一个jwks的认证 */ CreateJWKSAuthenticator(req: CreateJWKSAuthenticatorRequest, cb?: (error: string, rep: CreateJWKSAuthenticatorResponse) => void): Promise<CreateJWKSAuthenticatorResponse>; /** * 修改MQTT角色 */ ModifyUser(req: ModifyUserRequest, cb?: (error: string, rep: ModifyUserResponse) => void): Promise<ModifyUserResponse>; /** * 删除MQTT访问用户 */ DeleteUser(req: DeleteUserRequest, cb?: (error: string, rep: DeleteUserResponse) => void): Promise<DeleteUserResponse>; /** * 修改策略规则 */ ModifyAuthorizationPolicy(req: ModifyAuthorizationPolicyRequest, cb?: (error: string, rep: ModifyAuthorizationPolicyResponse) => void): Promise<ModifyAuthorizationPolicyResponse>; /** * 删除策略规则 */ DeleteAuthorizationPolicy(req: DeleteAuthorizationPolicyRequest, cb?: (error: string, rep: DeleteAuthorizationPolicyResponse) => void): Promise<DeleteAuthorizationPolicyResponse>; /** * 修改MQTT HTTP 认证器 */ ModifyHttpAuthenticator(req: ModifyHttpAuthenticatorRequest, cb?: (error: string, rep: ModifyHttpAuthenticatorResponse) => void): Promise<ModifyHttpAuthenticatorResponse>; /** * 根据认证器类型删除一个MQTT认证器 */ DeleteAuthenticator(req: DeleteAuthenticatorRequest, cb?: (error: string, rep: DeleteAuthenticatorResponse) => void): Promise<DeleteAuthenticatorResponse>; /** * 注册CA证书(仅一机一证场景支持),可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817) */ RegisterCaCertificate(req: RegisterCaCertificateRequest, cb?: (error: string, rep: RegisterCaCertificateResponse) => void): Promise<RegisterCaCertificateResponse>; /** * 查询MQTT认证器 */ DescribeAuthenticator(req: DescribeAuthenticatorRequest, cb?: (error: string, rep: DescribeAuthenticatorResponse) => void): Promise<DescribeAuthenticatorResponse>; /** * 激活Ca证书 */ ActivateCaCertificate(req: ActivateCaCertificateRequest, cb?: (error: string, rep: ActivateCaCertificateResponse) => void): Promise<ActivateCaCertificateResponse>; /** * 根据一级Topic查询消息列表 */ DescribeMessageList(req: DescribeMessageListRequest, cb?: (error: string, rep: DescribeMessageListResponse) => void): Promise<DescribeMessageListResponse>; /** * 添加mqtt角色 */ CreateUser(req: CreateUserRequest, cb?: (error: string, rep: CreateUserResponse) => void): Promise<CreateUserResponse>; /** * 查询共享订阅消息堆积量 */ DescribeSharedSubscriptionLag(req: DescribeSharedSubscriptionLagRequest, cb?: (error: string, rep: DescribeSharedSubscriptionLagResponse) => void): Promise<DescribeSharedSubscriptionLagResponse>; /** * 申请ca注册码 */ ApplyRegistrationCode(req: ApplyRegistrationCodeRequest, cb?: (error: string, rep: ApplyRegistrationCodeResponse) => void): Promise<ApplyRegistrationCodeResponse>; /** * 创建MQTT实例的性能测试任务 */ CreateAuthorizationPolicy(req: CreateAuthorizationPolicyRequest, cb?: (error: string, rep: CreateAuthorizationPolicyResponse) => void): Promise<CreateAuthorizationPolicyResponse>; /** * 修改实例属性,只有运行中的集群可以调用该接口进行变更配置。 */ ModifyInstance(req: ModifyInstanceRequest, cb?: (error: string, rep: ModifyInstanceResponse) => void): Promise<ModifyInstanceResponse>; /** * 创建一个HTTP的认证器 */ CreateHttpAuthenticator(req: CreateHttpAuthenticatorRequest, cb?: (error: string, rep: CreateHttpAuthenticatorResponse) => void): Promise<CreateHttpAuthenticatorResponse>; }