ListServiceInstanceResources - Compute Nest - Alibaba Cloud Documentation Center

Lists the resources in a service instance.

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

list

*ServiceInstance

acs:computenestsupplier:{#regionId}:{#accountId}:serviceinstance/{#serviceinstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	The query token. Set this to the NextToken value returned from the previous API call to retrieve the next page of results.	AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=
MaxResults	integer	No	The number of entries to return on each page. Maximum value: 100. Default value: 20.	20
ServiceInstanceId	string	Yes	The ID of the service instance.	si-d8a0cc2a1ee04dce****
Tag	array<object>	No	The resource tags.
	object	No	The resource tags.
Key	string	No	The tag key of the resource.	key1
Value	string	No	The tag value of the resource.	value1
RegionId	string	No	The region ID.	cn-hangzhou
ServiceInstanceResourceType	string	No	The type of the resource in the service instance. Valid values: AliyunResource: an Alibaba Cloud resource. ContainerResource: a pod.	AliyunResource
Filters	array<object>	No	The filter.
	object	No	The filter.
Name	string	No	The filter name. You can specify one or more filter names to query resources. Valid values: ExpireTimeStart ExpireTimeEnd PayType ResourceARN	ResourceARN
Values	array	No	The filter value.
	string	No	The filter value.	arn:acs:ecs:::instance/*

Response elements

Element	Type	Description	Example
	object
NextToken	string	The token to start the next query.	AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=
RequestId	string	The request ID.	B288A0BE-D927-4888-B0F7-B35EF84B6E6F
MaxResults	integer	The number of entries returned per page. Maximum value: 100. Default value: 20.	20
Resources	array<object>	The resources.
	object	The resources.
ResourceARN	string	The Alibaba Cloud Resource Name (ARN) of the resource.	arn:acs:sag:cn-hangzhou:130920852836**:ccn/ccn-b3qf0q439sq2de**
PayType	string	The billing method. Valid values: Subscription: subscription. PayAsYouGo: pay-as-you-go.	Subscription
RenewStatus	string	The renewal status. Valid values: AutoRenewal: auto-renewal. ManualRenewal: manual renewal. NotRenewal: no renewal.	AutoRenewal
CreateTime	string	The time when the resource was created.	2022-01-01T12:00:00
ExpireTime	string	The expiration time.	2022-03-01T12:00:00
RenewalPeriod	integer	The renewal period.	1
RenewalPeriodUnit	string	The unit of the renewal period. Valid values: Month: month. Year: year.	Month
ProductType	string	The product type.	RDS
ProductCode	string	The product code.	rds
Status	string	The status of the resource. Valid values: INIT_COMPLETE: The resource is pending creation. CREATE_COMPLETE: The resource is created. CREATE_FAILED: The resource failed to be created. CREATE_IN_PROGRESS: The resource is being created. UPDATE_IN_PROGRESS: The resource is being updated. UPDATE_FAILED: The resource failed to be updated. UPDATE_COMPLETE: The resource is updated. DELETE_IN_PROGRESS: The resource is being deleted. DELETE_FAILED: The resource failed to be deleted. DELETE_COMPLETE: The resource is deleted. CHECK_IN_PROGRESS: The resource is being checked. CHECK_FAILED: The resource failed to be checked. CHECK_COMPLETE: The resource is checked. IMPORT_IN_PROGRESS: The resource is being imported. IMPORT_FAILED: The resource failed to be imported. IMPORT_COMPLETE: The resource is imported.	CREATE_COMPLETE

Examples

Success response

JSON format

{
  "NextToken": "AAAAAc3HCuYhJi/wvpk4xOr0VLbAx7BkQzyYC+ONO+WudHGKEdB0uWSY7AGnM3qCgm/Ynge7zU6NWdbj0Tegyajyqyc=",
  "RequestId": "B288A0BE-D927-4888-B0F7-B35EF84B6E6F",
  "MaxResults": 20,
  "Resources": [
    {
      "ResourceARN": "arn:acs:sag:cn-hangzhou:130920852836****:ccn/ccn-b3qf0q439sq2de****",
      "PayType": "Subscription",
      "RenewStatus": "AutoRenewal",
      "CreateTime": "2022-01-01T12:00:00",
      "ExpireTime": "2022-03-01T12:00:00",
      "RenewalPeriod": 1,
      "RenewalPeriodUnit": "Month",
      "ProductType": "RDS",
      "ProductCode": "rds",
      "Status": "CREATE_COMPLETE"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.