All Products
Search

This Product

    CloudOps Orchestration Service:ListStateConfigurations

    Document Center

    CloudOps Orchestration Service:ListStateConfigurations

    Last Updated:Oct 14, 2024

    Queries desired-state configurations.

    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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    oos:ListStateConfigurationsget
    • StateConfiguration
      acs:oos:{#regionId}:{#accountId}:stateconfiguration/*
    • StateConfiguration
      acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#StateConfigurationId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringNo

    The region ID.

    		cn-hangzhou
    TemplateNamestringNo

    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
    TemplateVersionstringNo

    The version number of the template. If you do not specify this parameter, the latest version of the template is used.

    		v1
    StateConfigurationIdsstringNo

    The ID of the desired-state configuration.

    		["sc-asfgdhj12345"]
    TagsobjectNo

    The tags to be added to the configuration.

    		{"Key": "oos", "Value": "inventory"}
    MaxResultsintegerNo

    The maximum number of entries per page.

    		50
    NextTokenstringNo

    A pagination token. It can be used in the next request to retrieve a new page of results.

    		AHJKH-AHKJHDJK-AKHDIOWJL
    ResourceGroupIdstringNo

    The resource group ID.

    		rg-acfmxsn4m4******

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The request ID.

    		1306108F-610C-40FD-AAD5-DA13E8B00BE9
    StateConfigurationsarray<object>

    The information about the desired-state configurations.

    StateConfigurationobject
    UpdateTimestring

    The time when the configuration was updated.

    		2021-04-22T03:13:32Z
    CreateTimestring

    The time when the desired-state configuration was created.

    		2021-03-22T03:13:32Z
    Targetsstring

    The queried resources.

    		{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
    Tagsobject

    The tags added to the configuration.

    		{"Key": "oos", "Value": "inventory"}
    StateConfigurationIdstring

    The ID of the desired-state configuration.

    		sc-a538febe18fabcdef
    ScheduleExpressionstring

    The schedule expression.

    		1 hour
    TemplateNamestring

    The name of the template.

    		ACS-ECS-InventoryDataCollection
    TemplateVersionstring

    The version of the template.

    		v2
    ConfigureModestring

    The configuration mode. Valid values:

    		ApplyAndAutoCorrect
    ScheduleTypestring

    The schedule type.

    		rate
    Parametersstring

    The parameters.

    		{"policy": {"ACS:Network": {"Collection": "Enabled"}, "ACS:Application": {"Collection": "Enabled"}}}
    Descriptionstring

    The description.

    		Collect inventory data
    ResourceGroupIdstring

    The resource group ID.

    		rg-acfmxsn4m4******
    TemplateIdstring

    The template ID.

    		t-ajshjalscfhjk2214
    NextTokenstring

    The pagination token that was used in the next request to retrieve a new page of results.

    		AAAAASO3cL82+b5iji7bfPNpMh8=

    Examples

    Sample success responses

    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": {
        "Key": "oos",
        "Value": "inventory"
      },
      "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 Service error codes.

    Change history

    Change timeSummary of changesOperation
    No change history