ListStateConfigurations - 查询终态配置 - 运维编排服务

查询终态配置。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
oos:ListStateConfigurations	READ	OOS acs:oos:{#regionId}:{#accountId}:stateconfiguration/* OOS acs:oos:{#regionId}:{#accountId}:stateconfiguration/{#stateconfigurationId}	无	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	地域ID。	cn-hangzhou
TemplateName	string	否	模板名称。内容限制为字母、数字、中划线、下划线，长度200字符。	ACS-ECS-InventoryDataCollection
TemplateVersion	string	否	版本号，如不填默认为最新的版本号。	v1
StateConfigurationIds	string	否	终态配置ID。	["sc-asfgdhj12345"]
Tags	object	否	标签。
MaxResults	integer	否	每页返回的最大结果数。	50
NextToken	string	否	下一页Token。	AHJKH-AHKJHDJK-AKHDIOWJL
ResourceGroupId	string	否	资源组ID。	rg-acfmxsn4m4******

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求ID。	1306108F-610C-40FD-AAD5-DA13E8B00BE9
StateConfigurations	array	终态配置列表。
	object
UpdateTime	string	配置更新时间。	2021-04-22T03:13:32Z
CreateTime	string	创建时间。	2021-03-22T03:13:32Z
Targets	string	目标资源。	{ "ResourceType": "ALIYUN::ECS::Instance", "Filters": [ { "Type": "All", "RegionId": "cn-hangzhou", "Parameters": { "RegionId": "cn-hangzhou", "Status": "Running" } } ] }
Tags	object	标签。
StateConfigurationId	string	终态配置ID。	sc-a538febe18fabcdef
ScheduleExpression	string	定时表达式。	1 hour
TemplateName	string	模版名称。	ACS-ECS-InventoryDataCollection
TemplateVersion	string	模版版本。	v2
ConfigureMode	string	配置模式。	ApplyAndAutoCorrect
ScheduleType	string	定时类型。	rate
Parameters	string	参数。	{"policy": {"ACS:Network": {"Collection": "Enabled"}, "ACS:Application": {"Collection": "Enabled"}}}
Description	string	描述内容。	inventory数据收集
ResourceGroupId	string	资源组ID。	rg-acfmxsn4m4******
TemplateId	string	模版ID。	t-ajshjalscfhjk2214
NextToken	string	下一页token。	AAAAASO3cL82+b5iji7bfPNpMh8=

示例

请求示例

http(s)://[Endpoint]/?Action=ListStateConfigurations
&RegionId=cn-hangzhou
&TemplateName=ACS-ECS-InventoryDataCollection
&TemplateVersion=v1
&StateConfigurationIds=["sc-asfgdhj12345"]
&MaxResults=50
&NextToken=AHJKH-AHKJHDJK-AKHDIOWJL
&ResourceGroupId=rg-acfmxsn4m4******
&公共请求参数

正常返回示例

JSON格式

{
    "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\" } } ] }",
            "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": " inventory数据收集",
            "ResourceGroupId": "rg-acfmxsn4m4******",
            "TemplateId": "t-ajshjalscfhjk2214"
        }
    ]
}

XML格式

<ListStateConfigurationsResponse>
    <RequestId>1306108F-610C-40FD-AAD5-DA13E8B00BE9</RequestId>
    <StateConfigurations>
        <UpdateTime>2021-04-22T03:13:32Z</UpdateTime>
        <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>v2</TemplateVersion>
        <ConfigureMode>ApplyAndAutoCorrect</ConfigureMode>
        <ScheduleType>rate</ScheduleType>
        <Parameters>{"policy": {"ACS:Network": {"Collection": "Enabled"}, "ACS:Application": {"Collection": "Enabled"}}}</Parameters>
        <Description> inventory数据收集</Description>
        <ResourceGroupId>rg-acfmxsn4m4******</ResourceGroupId>
        <TemplateId>t-ajshjalscfhjk2214</TemplateId>
    </StateConfigurations>
</ListStateConfigurationsResponse>

错误码

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