全部产品
Search
文档中心

运维编排服务:CreateStateConfiguration - 创建一个终态配置

更新时间:Nov 11, 2022

创建终态配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
oos:CreateStateConfigurationWRITE
  • OOS
    acs:oos:{#regionId}:{#accountId}:stateconfiguration/*
  • OOS
    acs:oos:{#regionId}:{#accountId}:template/{#templateName}

请求参数

名称类型必填描述示例值
RegionIdstring

地域ID。

cn-hangzhou
Descriptionstring

终态配置的描述信息。

collect inventory data
TemplateNamestring

模板名称。内容限制为字母、数字、中划线、下划线,长度200字符。

ACS-ECS-InventoryDataCollection
TemplateVersionstring

版本号,如不填默认为最新的版本号。

v1
Parametersstring

参数。

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

配置模式。 ApplyOnly:配置只应用一次(更新配置后重新应用)。 ApplyAndMonitor: 配置只应用一次,成功应用后,后续只检查配置是否漂移。 ApplyAndAutoCorrect:总是应用配置。

ApplyOnce
ScheduleTypestring

调度类型。可选值:rate。

rate
ScheduleExpressionstring

调度表达式。调度间隔不得小于30分钟。

1 hour
Targetsstring

目标资源。

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

幂等token。

DASKJJLKADS-AHKLJHJSAKL-AJK
Tagsobject

标签。

ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

1306108F-610C-40FD-AAD5-DA13E8B00BE9
StateConfigurationobject

终态配置。

CreateTimestring

创建时间。

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

目标资源。

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

标签。

StateConfigurationIdstring

创建生成的配置ID。

sc-a538febe18fabcdef
ScheduleExpressionstring

定时表达式。

1 hour
TemplateNamestring

模板名称。

ACS-ECS-InventoryDataCollection
TemplateVersionstring

模板版本。

v1
ConfigureModestring

配置模式。

ApplyAndAutoCorrect
ScheduleTypestring

定时类型。

rate
Parametersobject

参数。

Descriptionstring

描述信息。

collect inventory data
ResourceGroupIdstring

资源组ID。

rg-acfmxsn4m4******
TemplateIdstring

模板ID。

t-1234asadf

示例

请求示例

http(s)://[Endpoint]/?Action=CreateStateConfiguration
&RegionId=cn-hangzhou
&Description=收集Inventory数据
&TemplateName=ACS-ECS-InventoryDataCollection
&TemplateVersion=v1
&Parameters={     "policy": {       "ACS:Application": {         "Collection": "Enabled"       },       "ACS:Network": {         "Collection": "Enabled"       }     }   }
&ConfigureMode=ApplyOnce
&ScheduleType=rate
&ScheduleExpression=1 hour 或 30 minutes
&Targets={     "ResourceType": "ALIYUN::ECS::Instance",     "Filters": [       {         "Type": "All",         "RegionId": "cn-hangzhou",         "Parameters": {           "RegionId": "cn-hangzhou",           "Status": "Running"         }       }     ]   }
&ClientToken=DASKJJLKADS-AHKLJHJSAKL-AJK
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

JSON格式

{
    "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\"         }       }     ]   }",
        "StateConfigurationId": "sc-a538febe18fabcdef",
        "ScheduleExpression": "1 hour",
        "TemplateName": "ACS-ECS-InventoryDataCollection",
        "TemplateVersion": "v1",
        "ConfigureMode": "ApplyAndAutoCorrect",
        "ScheduleType": "rate",
        "Description": "收集Inventory数据",
        "ResourceGroupId": "rg-acfmxsn4m4******",
        "Tags": {
            "oos": "inventory"
        },
        "TemplateId": "t-1234asadf"
    }
}

XML格式

<CreateStateConfigurationResponse>
    <RequestId>1306108F-610C-40FD-AAD5-DA13E8B00BE9</RequestId>
    <StateConfiguration>
        <CreateTime>2021-03-22T03:13:32Z</CreateTime>
        <Targets>{     "ResourceType": "ALIYUN::ECS::Instance",     "Filters": [       {         "Type": "All",         "RegionId": "cn-hangzhou",         "Parameters": {           "RegionId": "cn-hangzhou",           "Status": "Running"         }       }     ]   }</Targets>
        <StateConfigurationId>sc-a538febe18fabcdef</StateConfigurationId>
        <ScheduleExpression>1 hour</ScheduleExpression>
        <TemplateName>ACS-ECS-InventoryDataCollection</TemplateName>
        <TemplateVersion>v1</TemplateVersion>
        <ConfigureMode>ApplyAndAutoCorrect</ConfigureMode>
        <ScheduleType>rate</ScheduleType>
        <Description>收集Inventory数据</Description>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <Tags>
            <oos>inventory</oos>
        </Tags>
        <TemplateId>t-1234asadf</TemplateId>
    </StateConfiguration>
</CreateStateConfigurationResponse>

错误码

访问错误中心查看更多错误码。