Adds a consumer group to an AMQP subscription.

Limit

Each Alibaba Cloud account can run a maximum of 5 queries per second (QPS).

Note RAM users of an Alibaba Cloud account share the quota of the account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateConsumerGroupSubscribeRelation

The operation that you want to perform. Set the value to CreateConsumerGroupSubscribeRelation.

ConsumerGroupId String Yes nJRaJPn5U1JITGfjBO9l00****

The ID of the consumer group. After you call the CreateConsumerGroup operation to create a consumer group, the consumer group ID is returned. You can call the QueryConsumerGroupList operation to query the consumer group ID based on the group name. You can also log on to the IoT Platform console and choose Rules>Server-side Subscription>Consumer Groups to view the consumer group ID.

ProductKey String Yes a1fyXVF****

The ProductKey of the product that is specified for the subscription.

IotInstanceId String No iot-cn-0pp1n8t****

The ID of the instance. This parameter is not required for public instances. However, the parameter is required for the instances that you have purchased.

In addition to the preceding operation-specific request parameters, you must specify common request parameters when you call this API operation. For more information about common request parameters, see Common parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information about error codes, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the call fails.

RequestId String E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The call failed.

Examples

Sample requests

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateConsumerGroupSubscribeRelation
&ProductKey=a1Zkii7****
&ConsumerGroupId=nJRaJPn5U1JITGfjBO9l00****
&<Common request parameters>

Sample success responses

XML format

<CreateConsumerGroupSubscribeRelationResponse>
       <RequestId>73B9DF43-7780-47DE-8BED-077729D28BD2</RequestId>
       <Success>true</Success>
</CreateConsumerGroupSubscribeRelationResponse>

JSON format

{
  "RequestId": "73B9DF43-7780-47DE-8BED-077729D28BD2",
  "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.