DescribeTagHitsSummary-阿里云帮助中心

Queries statistics about tag hits. This is a legacy canvas API.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:DescribeTagHitsSummary

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	8fa1953f-4a84-46d8-b80c-8ce9cf684fb3
JobGroupId	string	Yes	The job group ID.	292eba45-df08-4065-87e7-7e587a1ce4ce

Response elements

Element	Type	Description	Example
	object	The data returned.
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The response code. `OK` indicates a successful request.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	5391EB13-A0E7-402D-A407-B99D4ABAF22A
Success	boolean	Indicates whether the request was successful.	true
TagGroups	array<object>	A list of tag groups.
	object	Details of the tag group.
TagGroupIndex	integer	The index of the tag group.	0
TagGroup	string	The tag group name.	标签组
ScriptId	string	The script ID.	8a4c6d3d-5ed6-44ca-b779-16c20f8862be
Id	string	The ID of the tag group.	8bb6f8ca-85a3-49f8-86a5-3127902a2156
TagHitsList	array<object>	A list of tag hit statistics.
	object	Statistics for a tag hit.
HitCount	integer	The hit count for the tag.	1
TagGroup	string	The tag group name.	当前学历
TagName	string	The tag name.	本科

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "5391EB13-A0E7-402D-A407-B99D4ABAF22A",
  "Success": true,
  "TagGroups": [
    {
      "TagGroupIndex": 0,
      "TagGroup": "标签组",
      "ScriptId": "8a4c6d3d-5ed6-44ca-b779-16c20f8862be",
      "Id": "8bb6f8ca-85a3-49f8-86a5-3127902a2156"
    }
  ],
  "TagHitsList": [
    {
      "HitCount": 1,
      "TagGroup": "当前学历",
      "TagName": "本科"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.
404	NotExist.JobGroup	The specified JobGroup does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.