Domain name for API request: cls.intl.tencentcloudapi.com.
This API is used to obtain the shipping rule information list.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeConsumers. |
| Version | Yes | String | Common Params. The value used for this API: 2020-10-16. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Filters.N | No | Array of Filter | - consumerId Filter by [Delivery Rule ID]. Type: String Required: No - topicId Filter by [Log topic]. Type: String Required: No - taskStatus Filter by [task running status]. Supported values: 0: stop, 1: running, 2: exception.Type: String Required: No Each request can have up to 10 Filters. The upper limit of Filter.Values is 10. |
| Offset | No | Integer | Paging offset. Default value: 0. |
| Limit | No | Integer | Pagination single page limit. The default value is 20, and the maximum value is 100. |
| Parameter Name | Type | Description |
|---|---|---|
| Consumers | Array of ConsumerInfo | Shipping rule list Note: This field may return null, indicating that no valid values can be obtained. |
| TotalCount | Integer | Total number obtained in this query |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cls.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeConsumers
<Common request parameters>
{
"Filters": [
{
"Key": "ConsumerId",
"Values": [
"xxxx-xxx-xxxx"
]
}
],
"Offset": 0,
"Limit": 10
}
{
"Response": {
"Consumers": [
{
"ConsumerId": "66f5808c-4a55-11eb-b378-0242ac131112",
"TopicId": "57f5808c-4a55-11eb-b378-0242ac130002",
"Effective": true,
"Ckafka": {
"Vip": "10.111.1.123",
"Vport": "8888",
"InstanceId": "ckafka-8j111111",
"InstanceName": "myname",
"TopicId": "topic-icjnxxx",
"TopicName": "125xxx-qwerty5-355a-492a-9dba-790271f5da27"
},
"NeedContent": true,
"Content": {
"EnableTag": true,
"MetaFields": [
"abc"
],
"TagJsonNotTiled": true,
"TimestampAccuracy": 0,
"JsonType": 0
},
"Compression": 0,
"CreateTime": 1662034960,
"RoleArn": "qcs::cam::uin/${uin}:roleName/xxxtest",
"ExternalId": "external_id_demo",
"TaskStatus": 1
}
],
"TotalCount": 1,
"RequestId": "1235808c-4a55-11eb-b378-0242ac133212"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| AuthFailure | CAM signature/authentication error. |
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| LimitExceeded | The quota limit has been reached. |
| MissingParameter | Missing parameter. |
| OperationDenied | Operation denied. |
| OperationDenied.ACLFailed | ACL verification failed. |
| OperationDenied.AccountDestroy | The account has been terminated. |
| OperationDenied.AccountIsolate | The account has overdue payments. |
| OperationDenied.AccountNotExists | The account does not exist. |
Esta página foi útil?
Você também pode entrar em contato com a Equipe de vendas ou Enviar um tíquete em caso de ajuda.
comentários