CreateStateConfiguration - CloudOps Orchestration Service

Creates a desired-state configuration.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

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 Key: the condition key that is defined by the cloud service.
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.

Operation	Access level	Resource type	Condition key	Associated operation
oos:CreateStateConfiguration	create	StateConfiguration acs:oos:{#regionId}:{#accountId}:stateconfiguration/*	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Description	string	No	The description of the desired-state configuration.	The region ID.
TemplateName	string	Yes	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 of the template. If you do not specify this parameter, the latest version of the template is used.	v1
Parameters	string	No	The parameters.	{ "policy": { "ACS:Application": { "Collection": "Enabled" }, "ACS:Network": { "Collection": "Enabled" } } }
ConfigureMode	string	No	The configuration mode. Valid values: ApplyOnce: The configuration is applied only once. After a configuration is updated, the new configuration is applied. ApplyAndMonitor: The configuration is applied only once. After the configuration is applied, the system only checks whether the configuration is migrated in the future. ApplyAndAutoCorrect: The configuration is always applied.	ApplyOnce
ScheduleType	string	Yes	The schedule type. Set the value to rate.	rate
ScheduleExpression	string	Yes	The schedule expression. The interval between two schedules must be a minimum of 30 minutes.	The ID of the resource group.
Targets	string	Yes	The resources to be queried.	{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
ClientToken	string	No	The client token that is used to ensure the idempotence of the request.	DASKJJLKADS-AHKLJHJSAKL-AJK
Tags	object	No	The tags to be added to the configuration.	{"Key": "oos", "Value": "inventory"}
ResourceGroupId	string	No	The resource group ID.	rg-acfmxsn4m4******

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The request ID.	1306108F-610C-40FD-AAD5-DA13E8B00BE9
StateConfiguration	object	The information about the desired-state configuration.
CreateTime	string	The time when the desired-state configuration was created.	2021-03-22T03:13:32Z
Targets	string	The queried resources.	{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
Tags	object	The tags added to the configuration.	{"Key": "oos", "Value": "inventory"}
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 name of the template version.	v1
ConfigureMode	string	The configuration mode. Valid values:	ApplyAndAutoCorrect
ScheduleType	string	The schedule type.	rate
Parameters	object	The parameters.	{"policy": {"ACS:Network": {"Collection": "Enabled"}, "ACS:Application": {"Collection": "Enabled"}}}
Description	string	The description.	collect inventory data
ResourceGroupId	string	The resource group ID.	rg-acfmxsn4m4******
TemplateId	string	The template ID.	t-1234asadf

Examples

Sample success responses

JSONformat

{
  "RequestId": "1306108F-610C-40FD-AAD5-DA13E8B00BE9",
  "StateConfiguration": {
    "CreateTime": "2021-03-22T03:13:32Z",
    "Targets": "{     \"ResourceType\": \"ALIYUN::ECS::Instance\",     \"Filters\": [       {         \"Type\": \"All\",         \"RegionId\": \"cn-hangzhou\",         \"Parameters\": {           \"RegionId\": \"cn-hangzhou\",           \"Status\": \"Running\"         }       }     ]   }",
    "Tags": {
      "Key": "oos",
      "Value": "inventory"
    },
    "StateConfigurationId": "sc-a538febe18fabcdef",
    "ScheduleExpression": "1 hour",
    "TemplateName": "ACS-ECS-InventoryDataCollection",
    "TemplateVersion": "v1",
    "ConfigureMode": "ApplyAndAutoCorrect",
    "ScheduleType": "rate",
    "Parameters": {
      "policy": {
        "ACS:Network": {
          "Collection": "Enabled"
        },
        "ACS:Application": {
          "Collection": "Enabled"
        }
      }
    },
    "Description": "collect inventory data\n",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "TemplateId": "t-1234asadf"
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history