Call the CreateStateConfiguration API to create a desired-state configuration - CloudOps Orchestration Service - Alibaba Cloud - CloudOps Orchestration Service

Creates a desired-state configuration to apply and maintain a specific resource state.

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

create

*StateConfiguration

acs:oos:{#regionId}:{#accountId}:stateconfiguration/*

oos:TLSVersion

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.	collect inventory data
TemplateName	string	Yes	The template name. 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 template version. If you do not specify this parameter, the latest version 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 monitors whether the configuration drifts. 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 minimum interval between two schedules is 30 minutes.	1 hour
Targets	string	Yes	The target resources.	{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
ClientToken	string	No	The client token used to ensure the idempotence of the request.	DASKJJLKADS-AHKLJHJSAKL-AJK
Tags	object	No	The tags to add to the configuration.	{"Key": "oos", "Value": "inventory"}
ResourceGroupId	string	No	The resource group ID.	rg-acfmxsn4m4******

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	1306108F-610C-40FD-AAD5-DA13E8B00BE9
StateConfiguration	object	The information about the created desired-state configuration.
CreateTime	string	The time when the desired-state configuration was created.	2021-03-22T03:13:32Z
Targets	string	The target resources.	{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
Tags	object	The tags of 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 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

Success response

JSON format

{
  "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",
    "ResourceGroupId": "rg-acfmxsn4m4******",
    "TemplateId": "t-1234asadf"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.