ListInstancePackageStates - CloudOps Orchestration Service

Lists the status of each package on an 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

oos:ListInstancePackageStates

list

*Template

acs:oos:{#regionId}:{#accountId}:template/{#templateNames}

oos:tag
oos:TLSVersion

None

Request parameters

Parameter	Type	Required	Description	Example
TemplateNames	string	No	A list of extension names.	["template1","template2"]
RegionId	string	No	The region ID.	cn-hangzhou
InstanceId	string	Yes	The ID of the ECS instance.	i-bp1cpoxxxwxxxxxxxxxx
MaxResults	integer	No	The page size.	50
NextToken	string	No	The pagination token.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctzxxxxxxx

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	ID of the request	1306108F-610C-40FD-AAD5-XXXXXX
MaxResults	string	The page size.	50
NextToken	string	The token that is used for pagination.	MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctzxxxxxxx
PackageStates	array<object>	A list of extensions.
	object
TemplateId	string	The template ID.	087b1e11072a40259f6fxxxxxxxxx
TemplateName	string	The template name.	ACS-ECS-Docker
TemplateVersion	string	The version number of the template.	v3
TemplateVersionName	string	The version name of the template.	fix bug
TemplateCategory	string	The type of the template.	Package
UpdateTime	string	The time when the template was updated.	2024-05-04T11:17:28
Description	string	The description.	template description
Publisher	string	The publisher.	Alibaba Cloud
Parameters	string	The parameters.	{}
ConfigurationInfo	string	The configuration information of the extension.	{\"publicUrl\": \"https://47.110.64.186:8888/5eff94f8\", \"privateUrl\": \"https://172.20.160.110:8888/5eff94f8\", \"username\": \"user\", \"password\": \"baotaOSuaOHt\"}\n

Examples

Success response

JSON format

{
  "RequestId": "1306108F-610C-40FD-AAD5-XXXXXX",
  "MaxResults": "50",
  "NextToken": "MTRBMDc0NjAtRUJFNy00N0NBLTk3NTctzxxxxxxx",
  "PackageStates": [
    {
      "TemplateId": "087b1e11072a40259f6fxxxxxxxxx",
      "TemplateName": "ACS-ECS-Docker",
      "TemplateVersion": "v3",
      "TemplateVersionName": "fix bug",
      "TemplateCategory": "Package",
      "UpdateTime": "2024-05-04T11:17:28",
      "Description": "template description",
      "Publisher": "Alibaba Cloud",
      "Parameters": "{}",
      "ConfigurationInfo": "{\\\"publicUrl\\\": \\\"https://47.110.64.186:8888/5eff94f8\\\", \\\"privateUrl\\\": \\\"https://172.20.160.110:8888/5eff94f8\\\", \\\"username\\\": \\\"user\\\", \\\"password\\\": \\\"baotaOSuaOHt\\\"}\\n"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.