文档

ListGroupId - 查看某实例下的所有 Group ID

更新时间:
一键部署

调用ListGroupId查看某实例下的所有Group ID。

接口说明

每成功调用一次 ListGroupId 接口,都会计算为一次消息 TPS,从而影响您的计费。计费详情,请参见计费说明

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

需查询的 Group ID 列表的实例的 ID。

mqtt-cn-0pp1ldu****
说明 更多参数说明请参见公共参数服务接入点

返回参数

名称类型描述示例值
object
RequestIdstring

公共参数,每个请求的 ID 都是唯一的。

95996EEB-D894-44FA-A87C-940F5CD9****
Dataarray<object>

所查询的 Group ID 的详细信息。

MqttGroupIdDoobject
UpdateTimelong

该 Group ID 的最近一次更新时间。

1564577317000
InstanceIdstring

查询的 Group ID 所属实例的 ID。

post-cn-45910tj****
IndependentNamingboolean

该实例是否有独立命名空间。取值如下:

  • true:有独立命名空间,该实例下的资源需保证命名唯一,跨实例可重名。

  • false:无独立命名空间,该实例下的资源需保证全局命名唯一,跨实例不可重名。

true
GroupIdstring

查询到的属于该实例的 Group ID。

GID_test1
CreateTimelong

该 Group ID 的创建时间。

1564577317000

示例

正常返回示例

JSON格式

{
  "RequestId": "95996EEB-D894-44FA-A87C-940F5CD9****",
  "Data": [
    {
      "UpdateTime": 1564577317000,
      "InstanceId": "post-cn-45910tj****",
      "IndependentNaming": true,
      "GroupId": "GID_test1",
      "CreateTime": 1564577317000
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ParameterFieldCheckFailedFailed to validate the parameters. The parameters may be missing or invalid.参数校验失败,可能缺失或者传入值非法。
400InstancePermissionCheckFailedAn error occurred while validating the permissions of the instance. Please verify the account that created the instance and its permissions settings.实例权限校验失败,请确认MQTT实例的所属关系以及授权策略。
400InstanceNotFoundFailed to find the instance. The instanceId may be invalid.无法找到实例。
400PermissionCheckFailedAn error occurred while validating the resource permissions. Please check the account that created the instance, topic, and GroupId, and check their permission settings.资源权限校验失败,请检查实例、Topic和Group ID的所属权限和授权策略。
500InternalErrorAn error occurred while processing your request. Try again later.MQTT后端服务异常,请重试。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史