ListServiceEntries-阿里云帮助中心

Query statistics entries for an application.

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

iotcc:ListServiceEntries

get

*CloudConnector

acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceId	string	Yes	The globally unique ID that the system assigns to the application-based statistics service.	c910061f-**-44e6-b659-*c
IoTCloudConnectorId	string	Yes	The ID of the cloud connector instance.	iotcc-bp1odcab8tmno0hdq****
Target	array	No	The destination address of the service entry.
	string	No	The destination address of the service entry. You can specify up to 20 destination addresses.	192.168.1.32/27
TargetType	array	No	The type of the destination address of the service entry.
	string	No	The type of the destination address of the service entry. You can specify up to 20 destination address types. Valid values: Cidr: A CIDR block. Domain: A domain name.	Cidr
ServiceEntryStatus	array	No	The status of the service entry.
	string	No	The status of the service entry. You can specify up to 20 statuses. Valid values: Creating: The service entry is being created. Created: The service entry is created. Deleting: The service entry is being deleted. Updating: The service entry is being updated.	Created
ServiceEntryName	array	No	The name of the service entry.
	string	No	The name of the service entry. You can specify up to 20 names. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-).	entry_name
NextToken	string	No	The token used for the next query. Valid values: Leave this parameter empty for the first query or when no more results are available. If more results are available, set this parameter to the value of NextToken returned by the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
RegionId	string	Yes	The region ID where the service entries reside. You can call the ListRegions operation to query the region ID.	cn-hangzhou
ServiceEntryIds	array	No	Application entry ID.
	string	No	The IDs of the service entries. You can specify up to 20 IDs.	fwd-119smw5tkasdf****

Response elements

Element	Type	Description	Example
	object	The request ID.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
TotalCount	integer	The total number of entries in the list.	10
NextToken	string	The token used for the next query. Valid values: If NextToken is empty, no more results are available. If NextToken has a value, use it as the starting token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The maximum number of entries to return on each page.	20
ServiceEntries	array<object>	The list of service entries.
	object	The list of service entries.
ServiceId	string	The globally unique ID that the system assigns to the application-based statistics service.	c910061f-**-44e6-b659-*c
ServiceEntryStatus	string	The status of the service entry. Valid values: Creating: The service entry is being created. Created: The service entry is created. Deleting: The service entry is being deleted. Updating: The service entry is being updated.	Created
Target	string	The destination address of the service entry.	192.168.1.32/27
TargetType	string	The type of the destination address of the service entry. Valid values: Cidr: A CIDR block. Domain: A domain name.	Cidr
ServiceEntryName	string	The name of the service entry. The name must be 2 to 128 characters in length. It must start with a letter or Chinese character. It can contain letters, digits, periods (.), underscores (_), and hyphens (-).	entry_name
ServiceEntryDescription	string	The description of the service entry. The description must be 2 to 256 characters in length. It must start with a letter or Chinese character. It cannot start with `http://` or `https://`.	entry_description
ServiceEntryId	string	The ID of the service entry.	fwd-119smw5tkasdf****

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "TotalCount": 10,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "ServiceEntries": [
    {
      "ServiceId": "c910061f-****-44e6-b659-***c",
      "ServiceEntryStatus": "Created",
      "Target": "192.168.1.32/27",
      "TargetType": "Cidr",
      "ServiceEntryName": "entry_name",
      "ServiceEntryDescription": "entry_description",
      "ServiceEntryId": "fwd-119smw5tkasdf****"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.RAM	Ram user does not have permission to perform this operation.	The error message returned because the RAM user does not have the permissions to perform the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.