tencentcloud-sdk-nodejs 4.1.227 → 4.1.228

package/tencentcloud/services/mqtt/v20240516/mqtt_client.d.ts

@@ -1,6 +1,6 @@
 import { AbstractClient } from "../../../common/abstract_client";
 import { ClientConfig } from "../../../common/interface";
-import { UpdateAuthorizationPolicyPriorityResponse, ModifyDeviceIdentityResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, DescribeMessageListRequest, DeleteDeviceIdentityRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DescribeSharedSubscriptionLagResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DescribeSharedSubscriptionGroupsRequest, DeleteAuthenticatorRequest, DeleteMessageEnrichmentRuleRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, DescribeDeviceIdentitiesRequest, CreateMessageEnrichmentRuleResponse, RegisterCaCertificateResponse, KickOutClientResponse, DescribeMessageDetailsRequest, DeleteInstanceRequest, ModifyInstanceRequest, CreateDeviceIdentityRequest, RegisterDeviceCertificateResponse, DescribeClientListResponse, DescribeMessageListResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyMessageEnrichmentRuleRequest, ModifyInstanceResponse, AddClientSubscriptionRequest, CreateHttpAuthenticatorResponse, UpdateMessageEnrichmentRulePriorityResponse, ModifyJWKSAuthenticatorResponse, DeleteDeviceIdentityResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeMessageEnrichmentRulesResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeMessageByTopicRequest, DescribeUserListRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DescribeMessageByTopicResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, ModifyHttpAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DeleteClientSubscriptionRequest, DescribeMessageDetailsResponse, DescribeUserListResponse, DeleteMessageEnrichmentRuleResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, DescribeClientListRequest, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, AddClientSubscriptionResponse, CreateTopicResponse, RevokedDeviceCertificateRequest, ModifyInsPublicEndpointResponse, CreateInstanceRequest, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateAuthorizationPolicyResponse, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, DescribeDeviceCertificatesResponse, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, UpdateMessageEnrichmentRulePriorityRequest, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeInsPublicEndpointsRequest, CreateDeviceIdentityResponse, KickOutClientRequest, DescribeDeviceIdentityResponse, ModifyTopicResponse, DeleteClientSubscriptionResponse, DescribeCaCertificateRequest, DescribeMessageEnrichmentRulesRequest, UpdateAuthorizationPolicyPriorityRequest, CreateMessageEnrichmentRuleRequest, DescribeSharedSubscriptionGroupsResponse, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeDeviceIdentityRequest, ModifyDeviceIdentityRequest, DescribeAuthorizationPoliciesRequest, RevokedDeviceCertificateResponse, CreateHttpAuthenticatorRequest, DescribeProductSKUListRequest, DescribeSharedSubscriptionLagRequest, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyMessageEnrichmentRuleResponse, ModifyAuthorizationPolicyRequest, DescribeTopicListResponse, DeleteTopicResponse, ModifyInstanceCertBindingRequest, ModifyHttpAuthenticatorRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse, DescribeDeviceIdentitiesResponse } from "./mqtt_models";
+import { UpdateAuthorizationPolicyPriorityResponse, ModifyDeviceIdentityResponse, DeleteUserRequest, ModifyJWTAuthenticatorResponse, ModifyAuthorizationPolicyResponse, ActivateDeviceCertificateRequest, CreateInstanceResponse, ApplyRegistrationCodeRequest, DescribeMessageListRequest, DescribeSharedSubscriptionsRequest, DeleteDeviceIdentityRequest, ModifyJWTAuthenticatorRequest, DescribeInsPublicEndpointsResponse, DescribeSharedSubscriptionLagResponse, DeleteTopicRequest, ModifyUserResponse, DescribeCaCertificateResponse, DescribeDeviceCertificatesRequest, DescribeSharedSubscriptionGroupsRequest, DeleteAuthenticatorRequest, DeleteMessageEnrichmentRuleRequest, DeleteAuthorizationPolicyResponse, ModifyJWKSAuthenticatorRequest, DescribeDeviceIdentitiesRequest, CreateMessageEnrichmentRuleResponse, RegisterCaCertificateResponse, KickOutClientResponse, DescribeMessageDetailsRequest, DeleteInstanceRequest, ModifyInstanceRequest, CreateDeviceIdentityRequest, RegisterDeviceCertificateResponse, DescribeClientListResponse, DescribeMessageListResponse, DescribeInstanceListResponse, ApplyRegistrationCodeResponse, ModifyMessageEnrichmentRuleRequest, ModifyInstanceResponse, AddClientSubscriptionRequest, CreateHttpAuthenticatorResponse, DescribeSharedSubscriptionClientRequest, UpdateMessageEnrichmentRulePriorityResponse, ModifyJWKSAuthenticatorResponse, DeleteDeviceIdentityResponse, CreateInsPublicEndpointResponse, CreateUserResponse, CreateAuthorizationPolicyRequest, PublishMessageResponse, DescribeMessageEnrichmentRulesResponse, DescribeAuthenticatorResponse, DeactivateCaCertificateResponse, DeleteCaCertificateRequest, DeleteDeviceCertificateRequest, DescribeMessageByTopicRequest, DescribeUserListRequest, DeleteUserResponse, ActivateCaCertificateResponse, DeleteDeviceCertificateResponse, DescribeMessageByTopicResponse, DeleteInstanceResponse, DescribeProductSKUListResponse, CreateJWKSAuthenticatorRequest, DescribeTopicResponse, CreateJWKSAuthenticatorResponse, ModifyHttpAuthenticatorResponse, DescribeAuthorizationPoliciesResponse, CreateTopicRequest, DeleteCaCertificateResponse, DescribeSharedSubscriptionClientResponse, DeleteClientSubscriptionRequest, DescribeMessageDetailsResponse, DescribeUserListResponse, DeleteMessageEnrichmentRuleResponse, DeactivateDeviceCertificateResponse, ActivateCaCertificateRequest, ActivateDeviceCertificateResponse, DescribeTopicRequest, PublishMessageRequest, DescribeClientListRequest, DeleteInsPublicEndpointResponse, DescribeInsVPCEndpointsRequest, DescribeTopicListRequest, AddClientSubscriptionResponse, CreateTopicResponse, RevokedDeviceCertificateRequest, ModifyInsPublicEndpointResponse, CreateInstanceRequest, DescribeAuthenticatorRequest, RegisterCaCertificateRequest, CreateAuthorizationPolicyResponse, DescribeSharedSubscriptionsResponse, CreateInsPublicEndpointRequest, RegisterDeviceCertificateRequest, DeactivateDeviceCertificateRequest, DescribeDeviceCertificatesResponse, ModifyTopicRequest, CreateUserRequest, DescribeInstanceResponse, ModifyInstanceCertBindingResponse, UpdateMessageEnrichmentRulePriorityRequest, DescribeInsVPCEndpointsResponse, DescribeDeviceCertificateRequest, ModifyInsPublicEndpointRequest, DeleteInsPublicEndpointRequest, DescribeInsPublicEndpointsRequest, CreateDeviceIdentityResponse, KickOutClientRequest, DescribeDeviceIdentityResponse, ModifyTopicResponse, DeleteClientSubscriptionResponse, DescribeCaCertificateRequest, DescribeMessageEnrichmentRulesRequest, UpdateAuthorizationPolicyPriorityRequest, CreateMessageEnrichmentRuleRequest, DescribeSharedSubscriptionGroupsResponse, CreateJWTAuthenticatorResponse, DeleteAuthorizationPolicyRequest, DescribeDeviceIdentityRequest, ModifyDeviceIdentityRequest, DescribeAuthorizationPoliciesRequest, RevokedDeviceCertificateResponse, CreateHttpAuthenticatorRequest, DescribeProductSKUListRequest, DescribeSharedSubscriptionLagRequest, DescribeDeviceCertificateResponse, DescribeInstanceListRequest, DeactivateCaCertificateRequest, CreateJWTAuthenticatorRequest, DescribeCaCertificatesRequest, ModifyMessageEnrichmentRuleResponse, ModifyAuthorizationPolicyRequest, DescribeTopicListResponse, DeleteTopicResponse, ModifyInstanceCertBindingRequest, ModifyHttpAuthenticatorRequest, DescribeInstanceRequest, DescribeCaCertificatesResponse, ModifyUserRequest, DeleteAuthenticatorResponse, DescribeDeviceIdentitiesResponse } from "./mqtt_models";
 /**
  * mqtt client
  * @class
@@ -186,6 +186,10 @@ export declare class Client extends AbstractClient {
      * 删除MQTT主题
      */
     DeleteTopic(req: DeleteTopicRequest, cb?: (error: string, rep: DeleteTopicResponse) => void): Promise<DeleteTopicResponse>;
+    /**
+     * 查询共享订阅组订阅列表
+     */
+    DescribeSharedSubscriptions(req: DescribeSharedSubscriptionsRequest, cb?: (error: string, rep: DescribeSharedSubscriptionsResponse) => void): Promise<DescribeSharedSubscriptionsResponse>;
     /**
      * 为MQTT客户端增加一条订阅
      */
@@ -235,6 +239,10 @@ export declare class Client extends AbstractClient {
      * 根据认证器类型删除一个MQTT认证器
      */
     DeleteAuthenticator(req: DeleteAuthenticatorRequest, cb?: (error: string, rep: DeleteAuthenticatorResponse) => void): Promise<DeleteAuthenticatorResponse>;
+    /**
+     * 查询共享订阅组详情信息
+     */
+    DescribeSharedSubscriptionClient(req: DescribeSharedSubscriptionClientRequest, cb?: (error: string, rep: DescribeSharedSubscriptionClientResponse) => void): Promise<DescribeSharedSubscriptionClientResponse>;
     /**
      * 注册CA证书（仅一机一证场景支持），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)
      */

package/tencentcloud/services/mqtt/v20240516/mqtt_client.js

@@ -290,6 +290,12 @@ class Client extends abstract_client_1.AbstractClient {
     async DeleteTopic(req, cb) {
         return this.request("DeleteTopic", req, cb);
     }
+    /**
+     * 查询共享订阅组订阅列表
+     */
+    async DescribeSharedSubscriptions(req, cb) {
+        return this.request("DescribeSharedSubscriptions", req, cb);
+    }
     /**
      * 为MQTT客户端增加一条订阅
      */
@@ -363,6 +369,12 @@ class Client extends abstract_client_1.AbstractClient {
     async DeleteAuthenticator(req, cb) {
         return this.request("DeleteAuthenticator", req, cb);
     }
+    /**
+     * 查询共享订阅组详情信息
+     */
+    async DescribeSharedSubscriptionClient(req, cb) {
+        return this.request("DescribeSharedSubscriptionClient", req, cb);
+    }
     /**
      * 注册CA证书（仅一机一证场景支持），可参考 [自定义 X.509 证书实现 “一机一证”](https://cloud.tencent.com/document/product/1778/114817)
      */

package/tencentcloud/services/mqtt/v20240516/mqtt_models.d.ts

@@ -267,6 +267,19 @@ export interface DescribeMessageListRequest {
      */
     Limit?: number;
 }
+/**
+ * DescribeSharedSubscriptions请求参数结构体
+ */
+export interface DescribeSharedSubscriptionsRequest {
+    /**
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
+     */
+    InstanceId: string;
+    /**
+     * 共享订阅组名
+     */
+    SharedName: string;
+}
 /**
  * DeleteDeviceIdentity请求参数结构体
  */
@@ -1284,6 +1297,23 @@ export interface MQTTMessageItem {
      */
     Qos?: string;
 }
+/**
+ * DescribeSharedSubscriptionClient请求参数结构体
+ */
+export interface DescribeSharedSubscriptionClientRequest {
+    /**
+     * 腾讯云MQTT实例ID，从 [DescribeInstanceList](https://cloud.tencent.com/document/api/1778/111029)接口或控制台获得。
+     */
+    InstanceId: string;
+    /**
+     * 共享订阅组名
+     */
+    SharedName: string;
+    /**
+     * 订阅表达式
+     */
+    TopicFilter: string;
+}
 /**
  * UpdateMessageEnrichmentRulePriority返回参数结构体
  */
@@ -1699,39 +1729,21 @@ export interface DeleteCaCertificateResponse {
     RequestId?: string;
 }
 /**
- * 共享订阅组
+ * DescribeSharedSubscriptionClient返回参数结构体
  */
-export interface SharedGroup {
+export interface DescribeSharedSubscriptionClientResponse {
     /**
-     * 腾讯云MQTT实例ID
+     * 共享订阅组下Client信息
      */
-    InstanceId?: string;
+    Data?: Array<SharedSubscriptionClient>;
     /**
-     * 共享订阅组名
-     */
-    SharedName?: string;
-    /**
-     * 共享组消费负载均衡策略 1.RANDOM 2.HASH_PARTITION
-     */
-    LbStrategy?: number;
-    /**
-     * HASH_PARTITION 策略下生效，表示Client掉线或新Client上线加入共享订阅组消费的延迟时间。
-  范围：0～600秒
-     */
-    ExpiryInterval?: number;
-    /**
-     * 备注，长度不超过128个字符。
-  注意：此字段可能返回 null，表示取不到有效值。
-     */
-    Remark?: string;
-    /**
-     * 创建时间，毫秒级时间戳 。
+     * 查询总数
      */
-    CreateTime?: number;
+    TotalCount?: number;
     /**
-     * 上次更新时间，毫秒级时间戳 。
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    UpdateTime?: number;
+    RequestId?: string;
 }
 /**
  * DeleteClientSubscription请求参数结构体
@@ -2089,6 +2101,41 @@ export interface DescribeClientListRequest {
      */
     Number?: string;
 }
+/**
+ * 共享订阅组
+ */
+export interface SharedGroup {
+    /**
+     * 腾讯云MQTT实例ID
+     */
+    InstanceId?: string;
+    /**
+     * 共享订阅组名
+     */
+    SharedName?: string;
+    /**
+     * 共享组消费负载均衡策略 1.RANDOM 2.HASH_PARTITION
+     */
+    LbStrategy?: number;
+    /**
+     * HASH_PARTITION 策略下生效，表示Client掉线或新Client上线加入共享订阅组消费的延迟时间。
+  范围：0～600秒
+     */
+    ExpiryInterval?: number;
+    /**
+     * 备注，长度不超过128个字符。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Remark?: string;
+    /**
+     * 创建时间，毫秒级时间戳 。
+     */
+    CreateTime?: number;
+    /**
+     * 上次更新时间，毫秒级时间戳 。
+     */
+    UpdateTime?: number;
+}
 /**
  * DeleteInsPublicEndpoint返回参数结构体
  */
@@ -2360,6 +2407,27 @@ export interface CreateAuthorizationPolicyResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeSharedSubscriptions返回参数结构体
+ */
+export interface DescribeSharedSubscriptionsResponse {
+    /**
+     * 集群id
+     */
+    InstanceId?: string;
+    /**
+     * 共享组名
+     */
+    SharedName?: string;
+    /**
+     * 共享组下的订阅表达式列表
+     */
+    TopicFilter?: Array<string>;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateInsPublicEndpoint请求参数结构体
  */
@@ -2708,6 +2776,27 @@ export interface ModifyInsPublicEndpointRequest {
      */
     Rules: Array<PublicAccessRule>;
 }
+/**
+ * 共享订阅组下客户端
+ */
+export interface SharedSubscriptionClient {
+    /**
+     * 客户端ID
+     */
+    ClientId?: string;
+    /**
+     * 共享订阅组名
+     */
+    SharedName?: string;
+    /**
+     * 共享组下的订阅表达式列表
+     */
+    TopicFilter?: string;
+    /**
+     * 在线状态
+     */
+    Online?: boolean;
+}
 /**
  * DeleteInsPublicEndpoint请求参数结构体
  */