ListService-阿里云帮助中心

Queries services for application statistics.

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:ListService

get

*CloudConnector

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

None

Request parameters

Parameter	Type	Required	Description	Example
IoTCloudConnectorId	string	Yes	Cloud connector instance ID.	iotcc-bp1odcab8tmno0hdq****
ServiceIds	array	No	List of application statistics service IDs.
	string	No	The system-generated ID for the application statistics service, unique across the entire network. Enter a maximum of 20 service IDs.	c910061f-**-44e6-b659-*c
ServiceNames	array	No	A list of service names, grouped by application.
	string	No	Application statistics service name. Enter a maximum of 20 service names. The length is 2 to 128 characters. It must start with an uppercase or lowercase English letter. It can contain numbers, periods (.), underscores (_), and hyphens (-).	service_name
ResourceStatuses	array	No	List the statuses of service resources by application.
	string	No	The status of the service resource. Enter a maximum of 20 service resources. Values: Creating: Creating. Created: Created. Deleting: Deleting. Updating: Updating.	Created
NextToken	string	No	Whether a token exists for the next query. Values: Do not enter a value for the first query or if no next query exists. If a next query exists, the value is the NextToken returned by the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	No	The number of entries displayed per paged query. Value range: 1 to 100. Default value: 20.	20
RegionId	string	Yes	The region ID where the application statistics service is located. Call the ListRegions API to get the region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	List of returned information.
RequestId	string	Request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
TotalCount	integer	Total number of list entries.	10
NextToken	string	Whether a token exists for the next query. Values: If NextToken is empty, no next query exists. If NextToken has a return value, it indicates the token for the start of the next query.	NextToken FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	The number of entries displayed per paged query.	20
Services	array<object>	List of services.
	object	List of services.
IoTCloudConnectorId	string	Cloud connector instance ID.	iotcc-bp1odcab8tmno0hdq****
ServiceId	string	The system-generated ID for the application statistics service, unique across the entire network.	c910061f-**-44e6-b659-*c
ServiceStatus	string	The status of the service resource. Values: Creating: Creating. Created: Created. Deleting: Deleting. Updating: Updating.	Created
ServiceName	string	The name of the application statistics service. The length is 2 to 128 characters. It must start with an uppercase or lowercase English letter. It can contain numbers, periods (.), underscores (_), and hyphens (-).	service_name
ServiceDescription	string	Description of the application statistics service. The length is 2 to 256 characters. It must start with an uppercase or lowercase English letter. However, it cannot be `http://` or `https://`.	service_description

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "TotalCount": 10,
  "NextToken": "NextToken\tFFmyTO70tTpLG6I3FmYAXGKPd****",
  "MaxResults": 20,
  "Services": [
    {
      "IoTCloudConnectorId": "iotcc-bp1odcab8tmno0hdq****",
      "ServiceId": "c910061f-****-44e6-b659-***c",
      "ServiceStatus": "Created",
      "ServiceName": "service_name",
      "ServiceDescription": "service_description"
    }
  ]
}

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.