ListStateConfigurations - Operation Orchestration Service

Queries desired-state configurations.

Authorization information

The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All resources is used in the Resource type column of the operation.
Condition keyword: refers to the condition keyword defined by the cloud product itself.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operate	access level	Resource type	conditional keyword	Association operation
oos:ListStateConfigurations	READ	OOS acs:oos:{#regionId}:{#accountId}:stateconfiguration/* OOS acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}	without	without

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
TemplateName	string	No	The name of the template. The name must be 1 to 200 characters in length, and can contain letters, digits, hyphens (-), and underscores (_).	ACS-ECS-InventoryDataCollection
TemplateVersion	string	No	The version number. If you do not specify this parameter, the system uses the latest version.	v1
StateConfigurationIds	string	No	The ID of each desired-state configuration.	["sc-asfgdhj12345"]
Tags	object	No	The tag.
MaxResults	integer	No	The maximum number of entries to return on each page.	50
NextToken	string	No	The token of the next page.	AHJKH-AHKJHDJK-AKHDIOWJL
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmxsn4m4******

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1306108F-610C-40FD-AAD5-DA13E8B00BE9
StateConfigurations	array	The desired-state configurations.
	object
UpdateTime	string	The time when the configuration is updated.	2021-04-22T03:13:32Z
CreateTime	string	The creation time.	2021-03-22T03:13:32Z
Targets	string	The target EMR resource.	{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
Tags	object	The tag of the auxiliary media asset.
StateConfigurationId	string	The ID of the desired-state configuration.	sc-a538febe18fabcdef
ScheduleExpression	string	The schedule expression.	1 hour
TemplateName	string	The name of the template.	ACS-ECS-InventoryDataCollection
TemplateVersion	string	The version of the template.	v2
ConfigureMode	string	The configuration mode.	ApplyAndAutoCorrect
ScheduleType	string	The schedule type.	rate
Parameters	string	The parameters.	{"policy": {"ACS:Network": {"Collection": "Enabled"}, "ACS:Application": {"Collection": "Enabled"}}}
Description	string	The description.	Collect inventory data
ResourceGroupId	string	The ID of the resource group.	rg-acfmxsn4m4******
TemplateId	string	The ID of the cluster template.	t-ajshjalscfhjk2214
NextToken	string	The token that is used to retrieve the next page of results.	AAAAASO3cL82+b5iji7bfPNpMh8=

Example

Normal return example

JSONFormat

{
  "RequestId": "1306108F-610C-40FD-AAD5-DA13E8B00BE9",
  "StateConfigurations": [
    {
      "UpdateTime": "2021-04-22T03:13:32Z",
      "CreateTime": "2021-03-22T03:13:32Z",
      "Targets": "{ \"ResourceType\": \"ALIYUN::ECS::Instance\", \"Filters\": [ { \"Type\": \"All\", \"RegionId\": \"cn-hangzhou\", \"Parameters\": { \"RegionId\": \"cn-hangzhou\", \"Status\": \"Running\" } } ] }",
      "Tags": {
        "test": "test",
        "test2": 1
      },
      "StateConfigurationId": "sc-a538febe18fabcdef",
      "ScheduleExpression": "1 hour",
      "TemplateName": "ACS-ECS-InventoryDataCollection",
      "TemplateVersion": "v2",
      "ConfigureMode": "ApplyAndAutoCorrect",
      "ScheduleType": "rate",
      "Parameters": "{\"policy\": {\"ACS:Network\": {\"Collection\": \"Enabled\"}, \"ACS:Application\": {\"Collection\": \"Enabled\"}}}",
      "Description": "Collect inventory data",
      "ResourceGroupId": "rg-acfmxsn4m4******",
      "TemplateId": "t-ajshjalscfhjk2214"
    }
  ],
  "NextToken": "AAAAASO3cL82+b5iji7bfPNpMh8="
}

Error codes

For a list of error codes, visit the API error center.