ListServiceInstanceDeployDetails - Compute Nest - Alibaba Cloud Documentation Center

Queries the deployment details for service instances.

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

computenestsupplier:ListServiceInstanceDeployDetails

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
MaxResults	integer	No	The number of entries per page for a paged query. Maximum value: 100. Default value: 20.	20
NextToken	string	No	The token that is used to start the next query.	AAAAAZbOYA+x9UgM6xrgcMqFUjk=
Filter	array<object>	No	The filter.
	object	No	The filter.
Value	array	No	A list of filter values.
	string	No	The filter value.	service-c751ed91f2074af39779
Name	string	No	The name of the filter. This corresponds to the WHERE clause in SQL. Valid values: UserId ServiceId ServiceVersion ServiceInstanceId DeploySucceeded (The value can be True or False. The value is case-insensitive.) ErrorType ErrorCode	ServiceId
StartTime	string	No	The start of the time range to query. Use UTC+0 time in the yyyy-MM-ddTHH:mmZ format.	2024-08-25T02:23:00Z
EndTime	string	No	The end of the time range to query. Use UTC+0 time in the yyyy-MM-ddTHH:mmZ format.	2024-12-31T16:00:00Z
CycleTimeZone	string	No	The time zone. Example: +08:00 Valid values: -12:59 to +13:00	+08:00
Dimension	array	No	The name of the dimension. This corresponds to the GROUP BY clause in SQL. Valid values: UserId ServiceId ServiceVersion ServiceInstanceId DeploySucceeded ErrorType ErrorCode
	string	No	The aggregation dimension.	ErrorType
CycleType	string	No	The aggregation period. If you do not specify this parameter, the system queries the details. Valid values: Year Month Day All	Month

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token that is used to start the next query.	AAAAAW8kZY+u1sYOaYf5JmgmDQQ=
RequestId	string	The request ID.	0036D82E-0624-5B37-B797-C460F4B02026
TotalCount	integer	The total number of entries.	7
MaxResults	integer	The number of entries returned per page. The maximum value is 100. The default value is 20.	20
DeployDetails	array<object>	The deployment details of the service instance.
	object	The deployment details of the service instance.
Cycle	string	The aggregation period.	Month
Timestamp	string	The timestamp.	1723946641994
Count	string	The number of rows in the aggregate data.	4
CreateTime	string	The time when the entry was created.	2024-04-10T01:58:20Z
UserId	string	The user ID.	1591457835436382
ServiceId	string	The service ID.	service-c751ed91f2074af39779
ServiceVersion	string	The service version.	42
ServiceNameChn	string	The Chinese name of the service.	测试服务(Test Service)
ServiceNameEng	string	The English name of the service.	Test Service
ServiceInstanceId	string	The service instance ID.	si-273e8cee11d349e1803c
DeploySucceeded	string	Indicates whether the deployment was successful.	False
ErrorType	string	The type of the error that occurred when the deployment failed.	ValidationError
ErrorCode	string	The error code returned when the deployment failed.	StackValidationFailed
ErrorDetail	string	The error details.	{code: StackValidationFailed, message: \"Failed to continue create ROS stack 89e724e2-84e6-4517-a372-30a545ab4145: Resource [LinuxInstanceRunCommand]: i-wz91nfbh1fxtmfb0try4 are not running. Command invocation only support running instances. ErrorCode: StackValidationFailed\", requestId: null}
ServiceType	string	The service type. Valid values: private: The service is deployed in the user's account. managed: The service is hosted in the service provider's account. operation: The service is an Alibaba Cloud Managed Service.	private

Examples

Success response

JSON format

{
  "NextToken": "AAAAAW8kZY+u1sYOaYf5JmgmDQQ=",
  "RequestId": "0036D82E-0624-5B37-B797-C460F4B02026",
  "TotalCount": 7,
  "MaxResults": 20,
  "DeployDetails": [
    {
      "Cycle": "Month",
      "Timestamp": "1723946641994",
      "Count": "4",
      "CreateTime": "2024-04-10T01:58:20Z",
      "UserId": "1591457835436382",
      "ServiceId": "service-c751ed91f2074af39779",
      "ServiceVersion": "42",
      "ServiceNameChn": "测试服务(Test Service)",
      "ServiceNameEng": "Test Service",
      "ServiceInstanceId": "si-273e8cee11d349e1803c",
      "DeploySucceeded": "False",
      "ErrorType": "ValidationError",
      "ErrorCode": "StackValidationFailed",
      "ErrorDetail": "{code: StackValidationFailed, message: \\\"Failed to continue create ROS stack 89e724e2-84e6-4517-a372-30a545ab4145: Resource [LinuxInstanceRunCommand]: i-wz91nfbh1fxtmfb0try4 are not running. Command invocation only support running instances. ErrorCode: StackValidationFailed\\\", requestId: null}",
      "ServiceType": "private"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.