'1.0',
'info' => [
'style' => 'RPC',
'product' => 'Config',
'version' => '2019-01-08',
],
'directories' => [
[
'id' => 238069,
'title' => '资源',
'type' => 'directory',
'children' => [
'GetDiscoveredResourceCounts',
'ListDiscoveredResources',
'DescribeDiscoveredResource',
'GetResourceComplianceTimeline',
'GetResourceConfigurationTimeline',
'GetDiscoveredResourceSummary',
'GetSupportedResourceTypes',
],
],
[
'id' => 238077,
'title' => '规则',
'type' => 'directory',
'children' => [
'DeleteConfigRules',
'StartConfigRuleEvaluation',
'StopConfigRules',
'ListConfigRules',
'DescribeEvaluationResults',
'DescribeCompliance',
'DescribeComplianceSummary',
'DescribeConfigRule',
'PutConfigRule',
'PutEvaluations',
'ActiveConfigRules',
],
],
[
'id' => 238089,
'title' => '资源监控范围',
'type' => 'directory',
'children' => [
'StartConfigurationRecorder',
'DescribeConfigurationRecorder',
'PutConfigurationRecorder',
],
],
[
'id' => 238093,
'title' => '投递渠道',
'type' => 'directory',
'children' => [
'DescribeDeliveryChannels',
'PutDeliveryChannel',
],
],
[
'id' => 238096,
'title' => '其他',
'type' => 'directory',
'children' => [
'GetAggregateDiscoveredResource',
'ListAggregateDiscoveredResources',
],
],
],
'components' => [
'schemas' => [],
],
'apis' => [
'GetDiscoveredResourceCounts' => [
'summary' => '查询当前账号的资源数量。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'GroupByKey',
'in' => 'query',
'schema' => [
'description' => '资源数量统计的分组维度。取值:'."\n"
.'- ResourceType:资源类型。'."\n"
.'- Region:地域。',
'type' => 'string',
'required' => false,
'example' => 'ResourceType',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '120886317861****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'GroupedResourceCounts' => [
'description' => '资源数量查询结果。',
'type' => 'object',
'properties' => [
'GroupByKey' => [
'description' => '资源统计的分组维度。',
'type' => 'string',
'example' => 'ResourceType',
],
'GroupedResourceCountList' => [
'description' => '资源数量列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'GroupName' => [
'description' => '资源统计的分组名称。',
'type' => 'string',
'example' => 'ACS::ECS::SecurityGroup',
],
'ResourceCount' => [
'description' => '分组下统计的资源数量。',
'type' => 'integer',
'format' => 'int64',
'example' => '10',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '54BFA4FB-6E08-4D58-9E83-1A8A3EC80247',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"GroupedResourceCounts\\": {\\n \\"GroupByKey\\": \\"ResourceType\\",\\n \\"GroupedResourceCountList\\": [\\n {\\n \\"GroupName\\": \\"ACS::ECS::SecurityGroup\\",\\n \\"ResourceCount\\": 10\\n }\\n ]\\n },\\n \\"RequestId\\": \\"54BFA4FB-6E08-4D58-9E83-1A8A3EC80247\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\t54BFA4FB-6E08-4D58-9E83-1A8A3EC80247\\n\\t\\n\\t\\t\\n\\t\\t\\tACS::ECS::NetworkInterface\\n\\t\\t\\t13\\n\\t\\t\\n\\t\\t\\n\\t\\t\\tACS::ECS::SecurityGroup\\n\\t\\t\\t10\\n\\t\\t\\n\\t\\tResourceType\\n\\t\\n","errorExample":""}]',
'title' => '查询资源数量',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListDiscoveredResources' => [
'summary' => '查询当前账号资源列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。',
'type' => 'string',
'required' => false,
'example' => 'eni-hp31cqoba96jagtz****',
],
],
[
'name' => 'ResourceDeleted',
'in' => 'query',
'schema' => [
'description' => '资源状态。取值:'."\n"
."\n"
.'- 0:已删除。'."\n"
.'- 1(默认值):保有中。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '资源列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'ResourceTypes',
'in' => 'query',
'schema' => [
'description' => '资源类型。多个资源类型用半角逗号(,)分隔。',
'type' => 'string',
'required' => false,
'example' => 'ACS::ECS::NetworkInterface',
],
],
[
'name' => 'Regions',
'in' => 'query',
'schema' => [
'description' => '地域。多个地域用半角逗号(,)分隔。',
'type' => 'string',
'required' => false,
'example' => 'cn-huhehaote',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '120886341261****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'DiscoveredResourceProfiles' => [
'description' => '资源列表结果。',
'type' => 'object',
'properties' => [
'DiscoveredResourceProfileList' => [
'description' => '资源列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '120886317861****',
],
'Region' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-huhehaote',
],
'ResourceCreationTime' => [
'description' => '资源创建时间戳。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '1618675206000',
],
'ResourceDeleted' => [
'description' => '资源删除状态。取值:'."\n"
.'- 1:未删除。'."\n"
.'- 0:已删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'eni-hp31cqoba96jagtz****',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'Cloud Firewall',
],
'ResourceStatus' => [
'description' => '资源状态。资源的状态取决于各云服务对其的定义,该参数可能为空。'."\n"
.'例如:'."\n"
."\n"
.'- 当资源类型为ACS::ECS::Instance时,由于ECS实例有状态,因此该参数为Running或Stopped。'."\n"
."\n"
.'- 当资源类型为ACS::OSS::Bucket时,由于OSS Bucket无状态,因此该参数为空。',
'type' => 'string',
'example' => 'InUse',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ACS::ECS::NetworkInterface',
],
'Tags' => [
'description' => '资源标签。'."\n",
'type' => 'string',
'example' => '{\\"key1\\":[\\"value2\\"]}',
],
],
],
],
'PageNumber' => [
'description' => '资源列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'TotalCount' => [
'description' => '资源总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '129',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C7817373-78CB-4F9A-8AFA-E7A88E9D64A2',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DiscoveredResourceProfiles\\": {\\n \\"DiscoveredResourceProfileList\\": [\\n {\\n \\"AccountId\\": 0,\\n \\"Region\\": \\"cn-huhehaote\\",\\n \\"ResourceCreationTime\\": 1618675206000,\\n \\"ResourceDeleted\\": 1,\\n \\"ResourceId\\": \\"eni-hp31cqoba96jagtz****\\",\\n \\"ResourceName\\": \\"Cloud Firewall\\",\\n \\"ResourceStatus\\": \\"InUse\\",\\n \\"ResourceType\\": \\"ACS::ECS::NetworkInterface\\",\\n \\"Tags\\": \\"{\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"]}\\"\\n }\\n ],\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 129\\n },\\n \\"RequestId\\": \\"C7817373-78CB-4F9A-8AFA-E7A88E9D64A2\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\r\\n\\t\\t129\\r\\n\\t\\t1\\r\\n\\t\\t10\\r\\n\\t\\t\\r\\n\\t\\t\\t120886317861****\\r\\n\\t\\t\\t1618675206000\\r\\n\\t\\t\\teni-hp31cqoba96jagtz****\\r\\n\\t\\t\\tCloud Firewall\\r\\n\\t\\t\\tcn-huhehaote\\r\\n\\t\\t\\tInUse\\r\\n\\t\\t\\tACS::ECS::NetworkInterface\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\t{\\\\\\"key1\\\\\\":[\\\\\\"value2\\\\\\"]}\\r\\n\\t\\t\\r\\n\\t\\r\\n\\tC7817373-78CB-4F9A-8AFA-E7A88E9D64A2\\r\\n\\t","errorExample":""}]',
'title' => '查询资源列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDiscoveredResource' => [
'summary' => '查询指定资源的配置详情。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'adaf.zhilon****',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。'."\n"
."\n"
.'> 您可以通过GetSupportedResourceTypes接口获取配置审计支持的资源类型列表。更多信息,请参见[GetSupportedResourceTypes](~~169618~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ACS::CDN::Domain',
],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => false,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'DiscoveredResourceDetail' => [
'description' => '资源详情。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '987654321',
],
'AvailabilityZone' => [
'description' => '资源可用区。',
'type' => 'string',
'example' => 'cn-hangzhou-h',
],
'Configuration' => [
'description' => '资源的完整配置信息。',
'type' => 'string',
'example' => '{\\"Description\\":\\"\\",\\"SslProtocol\\":\\"off\\",\\"DomainName\\":\\"adaf.zhilong****\\",\\"GmtModified\\":\\"2019-04-10T03:11Z\\",\\"CdnType\\":\\"web\\",\\"GmtCreated\\":\\"2016-03-03T01:31:35Z\\",\\"Cname\\":\\"adaf.zhilong.me.w.kun****.com\\",\\"Sources\\":{\\"Source\\":[{\\"Type\\":\\"oss\\",\\"Content\\":\\"test2-mh.oss-cn-hangzhou.aliyuncs.com\\",\\"Priority\\":\\"20\\",\\"Port\\":80,\\"Weight\\":\\"10\\"}]},\\"DomainStatus\\":\\"offline\\",\\"Sandbox\\":\\"\\"}',
],
'Region' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ResourceCreationTime' => [
'description' => '资源创建时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1456968695000',
],
'ResourceDeleted' => [
'description' => '资源删除状态。取值:'."\n"
.'- 1:未删除。'."\n"
.'- 0:已删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'adaf.zhilon****',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'test-resource-name',
],
'ResourceStatus' => [
'description' => '资源状态。资源的状态取决于各云服务对其的定义,该参数可能为空。例如:'."\n"
."\n"
.'- 当资源类型为ACS::ECS::Instance时,由于ECS实例有状态,因此该参数为Running或Stopped。'."\n"
."\n"
.'- 当资源类型为ACS::OSS::Bucket时,由于OSS Bucket无状态,因此该参数为空。'."\n"
."\n"
.'- 当资源类型为ACS::CDN::Domain时,该参数取值为online、offline等。',
'type' => 'string',
'example' => 'offline',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ACS::CDN::Domain',
],
'Tags' => [
'description' => '资源标签。',
'type' => 'string',
'example' => '{\\"\\"hc\\"\\":[\\"\\"value2\\"\\"]}',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E4D71ACE-6B0A-46E0-8352-56952378CC7F',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DiscoveredResourceDetail\\": {\\n \\"AccountId\\": 987654321,\\n \\"AvailabilityZone\\": \\"cn-hangzhou-h\\",\\n \\"Configuration\\": \\"{\\\\\\\\\\\\\\"Description\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"SslProtocol\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"off\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DomainName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"adaf.zhilong****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"GmtModified\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2019-04-10T03:11Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CdnType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"web\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"GmtCreated\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2016-03-03T01:31:35Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Cname\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"adaf.zhilong.me.w.kun****.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Sources\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Source\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test2-mh.oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Priority\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"20\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Port\\\\\\\\\\\\\\":80,\\\\\\\\\\\\\\"Weight\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"10\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"DomainStatus\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"offline\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Sandbox\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResourceCreationTime\\": 1456968695000,\\n \\"ResourceDeleted\\": 1,\\n \\"ResourceId\\": \\"adaf.zhilon****\\",\\n \\"ResourceName\\": \\"test-resource-name\\",\\n \\"ResourceStatus\\": \\"offline\\",\\n \\"ResourceType\\": \\"ACS::CDN::Domain\\",\\n \\"Tags\\": \\"{\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"hc\\\\\\\\\\\\\\"\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"]}\\"\\n },\\n \\"RequestId\\": \\"E4D71ACE-6B0A-46E0-8352-56952378CC7F\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tE4D71ACE-6B0A-46E0-8352-56952378CC7F\\r\\n\\t\\r\\n\\t\\t987654321\\r\\n\\t\\tadaf.zhilon****\\r\\n\\t\\toffline\\r\\n\\t\\t{\\\\\\"Description\\\\\\":\\\\\\"\\\\\\",\\\\\\"SslProtocol\\\\\\":\\\\\\"off\\\\\\",\\\\\\"DomainName\\\\\\":\\\\\\"adaf.zhilong****\\\\\\",\\\\\\"GmtModified\\\\\\":\\\\\\"2019-04-10T03:11Z\\\\\\",\\\\\\"CdnType\\\\\\":\\\\\\"web\\\\\\",\\\\\\"GmtCreated\\\\\\":\\\\\\"2016-03-03T01:31:35Z\\\\\\",\\\\\\"Cname\\\\\\":\\\\\\"adaf.zhilong.me.w.kun****.com\\\\\\",\\\\\\"Sources\\\\\\":{\\\\\\"Source\\\\\\":[{\\\\\\"Type\\\\\\":\\\\\\"oss\\\\\\",\\\\\\"Content\\\\\\":\\\\\\"test2-mh.oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"Priority\\\\\\":\\\\\\"20\\\\\\",\\\\\\"Port\\\\\\":80,\\\\\\"Weight\\\\\\":\\\\\\"10\\\\\\"}]},\\\\\\"DomainStatus\\\\\\":\\\\\\"offline\\\\\\",\\\\\\"Sandbox\\\\\\":\\\\\\"\\\\\\"}\\r\\n\\t\\t1\\r\\n\\t\\ttest-resource-name\\r\\n\\t\\tcn-hangzhou\\r\\n\\t\\tcn-hangzhou-h\\r\\n\\t\\t1456968695000\\r\\n\\t\\t{\\\\\\"\\\\\\"hc\\\\\\"\\\\\\":[\\\\\\"\\\\\\"value2\\\\\\"\\\\\\"]}\\r\\n\\t\\tACS::CDN::Domain\\r\\n\\t\\r\\n\\t","errorExample":""}]',
'title' => '查询资源配置详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetResourceComplianceTimeline' => [
'summary' => '查询指定资源的合规检测历史。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ACS::ECS::Instance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'i-uf6072y75i2cevjq****',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间戳。默认为发起调用前的30天。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1593599340010',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间戳。默认为发起调用时的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1593599342230',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。默认值:10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'string',
'required' => false,
'example' => '123456789',
],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '下一个查询开始的Token。',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DE9FFFE5-FCAD-4B24-9546-BF49273C562B',
],
'ResourceComplianceTimeline' => [
'description' => '资源合规检测历史。',
'type' => 'object',
'properties' => [
'ComplianceList' => [
'description' => '资源合规检测历史列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '阿里云账号ID。',
'type' => 'string',
'example' => '120390217529****',
],
'AvailabilityZone' => [
'description' => '资源可用区。',
'type' => 'string',
'example' => 'cn-hangzhou-f',
],
'CaptureTime' => [
'description' => '合规评估时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1203902175292305',
],
'Configuration' => [
'description' => '资源关联的规则列表和规则合规详情。',
'type' => 'string',
'example' => '{\\"managetest-required-tags\\":[{},{\\"configRuleId\\":\\"cr-656d5180a8d1009c****\\",\\"configRuleArn\\":\\"acs:config::120390217529****:config-rule/cr-656d5180a8d1009c****\\",\\"configRuleName\\":\\"managetest-required-tags\\",\\"complianceType\\":\\"NON_COMPLIANT\\",\\"riskLevel\\":1,\\"annotation\\":\\"{\\\\\\"desiredValue\\\\\\":\\\\\\"key1\\\\\\",\\\\\\"reason\\\\\\":\\\\\\"No tag with name key1\\\\\\"}\\",\\"invokingEventMessageType\\":\\"ConfigurationItemChangeNotification\\"}]}',
],
'ConfigurationDiff' => [
'description' => '合规状态发生变化的规则详情。',
'type' => 'string',
'example' => '{\\"Compliance\\":{\\"complianceType\\":\\"NON_COMPLIANT\\",\\"count\\":2},\\"ConfigRuleList\\":[{\\"configRuleId\\":\\"cr-7b6e5180a8d100cc****\\",\\"configRuleArn\\":\\"acs:config::120390217529****:config-rule/cr-7b6e5180a8d100cc****\\",\\"configRuleName\\":\\"required-tags\\",\\"complianceType\\":\\"COMPLIANT\\",\\"riskLevel\\":1,\\"invokingEventMessageType\\":\\"ConfigurationItemChangeNotification\\"}]}',
],
'Region' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ResourceCreateTime' => [
'description' => '资源创建时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1203902175293610',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'i-uf6072y75i2cevjq****',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'test-resource',
],
'ResourceStatus' => [
'description' => '资源状态。资源状态取决于各云服务对其的定义,该参数可能为空。例如:'."\n"
."\n"
.'- 当资源类型为ACS::ECS::Instance时,由于ECS实例有状态,因此该参数为Running或Stopped。'."\n"
."\n"
.'- 当资源类型为ACS::OSS::Bucket时,由于OSS Bucket无状态,因此该参数为空。',
'type' => 'string',
'example' => 'Running',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ACS::ECS::Instance',
],
'Tags' => [
'description' => '资源标签。',
'type' => 'string',
'example' => '{\\"project\\":[\\"efg\\"]}',
],
],
],
],
'Limit' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '下一个查询开始的Token。',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'TotalCount' => [
'description' => '历史合规结果总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DE9FFFE5-FCAD-4B24-9546-BF49273C562B\\",\\n \\"ResourceComplianceTimeline\\": {\\n \\"ComplianceList\\": [\\n {\\n \\"AccountId\\": \\"120390217529****\\",\\n \\"AvailabilityZone\\": \\"cn-hangzhou-f\\",\\n \\"CaptureTime\\": 1203902175292305,\\n \\"Configuration\\": \\"{\\\\\\\\\\\\\\"managetest-required-tags\\\\\\\\\\\\\\":[{},{\\\\\\\\\\\\\\"configRuleId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cr-656d5180a8d1009c****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"configRuleArn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"acs:config::120390217529****:config-rule/cr-656d5180a8d1009c****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"configRuleName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"managetest-required-tags\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"complianceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NON_COMPLIANT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"riskLevel\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"annotation\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"desiredValue\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"reason\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"No tag with name key1\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"invokingEventMessageType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ConfigurationItemChangeNotification\\\\\\\\\\\\\\"}]}\\",\\n \\"ConfigurationDiff\\": \\"{\\\\\\\\\\\\\\"Compliance\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"complianceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"NON_COMPLIANT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"count\\\\\\\\\\\\\\":2},\\\\\\\\\\\\\\"ConfigRuleList\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"configRuleId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cr-7b6e5180a8d100cc****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"configRuleArn\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"acs:config::120390217529****:config-rule/cr-7b6e5180a8d100cc****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"configRuleName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"required-tags\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"complianceType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"COMPLIANT\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"riskLevel\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"invokingEventMessageType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ConfigurationItemChangeNotification\\\\\\\\\\\\\\"}]}\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResourceCreateTime\\": 1203902175293610,\\n \\"ResourceId\\": \\"i-uf6072y75i2cevjq****\\",\\n \\"ResourceName\\": \\"test-resource\\",\\n \\"ResourceStatus\\": \\"Running\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"Tags\\": \\"{\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"efg\\\\\\\\\\\\\\"]}\\"\\n }\\n ],\\n \\"Limit\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n caeba0bbb2be03f84eb48b699f0a****\\n \\n 120390217529****\\n 1203902175292305\\n {\\\\\\"Compliance\\\\\\":{\\\\\\"complianceType\\\\\\":\\\\\\"NON_COMPLIANT\\\\\\",\\\\\\"count\\\\\\":2},\\\\\\"ConfigRuleList\\\\\\":[{\\\\\\"configRuleId\\\\\\":\\\\\\"cr-7b6e5180a8d100cc****\\\\\\",\\\\\\"configRuleArn\\\\\\":\\\\\\"acs:config::120390217529****:config-rule/cr-7b6e5180a8d100cc****\\\\\\",\\\\\\"configRuleName\\\\\\":\\\\\\"required-tags\\\\\\",\\\\\\"complianceType\\\\\\":\\\\\\"COMPLIANT\\\\\\",\\\\\\"riskLevel\\\\\\":1,\\\\\\"invokingEventMessageType\\\\\\":\\\\\\"ConfigurationItemChangeNotification\\\\\\"}]}\\n {\\\\\\"managetest-required-tags\\\\\\":[{},{\\\\\\"configRuleId\\\\\\":\\\\\\"cr-656d5180a8d1009c****\\\\\\",\\\\\\"configRuleArn\\\\\\":\\\\\\"acs:config::120390217529****:config-rule/cr-656d5180a8d1009c****\\\\\\",\\\\\\"configRuleName\\\\\\":\\\\\\"managetest-required-tags\\\\\\",\\\\\\"complianceType\\\\\\":\\\\\\"NON_COMPLIANT\\\\\\",\\\\\\"riskLevel\\\\\\":1,\\\\\\"annotation\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"desiredValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"reason\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"No tag with name key1\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"invokingEventMessageType\\\\\\":\\\\\\"ConfigurationItemChangeNotification\\\\\\"}]}\\n i-uf6072y75i2cevjq****\\n test-resource\\n cn-hangzhou-f\\n cn-hangzhou\\n Running\\n ACS::ECS::Instance\\n 1203902175293610\\n {\\\\\\"project\\\\\\":[\\\\\\"efg\\\\\\"]}\\n \\n 10\\n DE9FFFE5-FCAD-4B24-9546-BF49273C562B\\n","errorExample":""}]',
'title' => '查询资源合规检测历史',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetResourceConfigurationTimeline' => [
'summary' => '查询指定资源的配置变更历史。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'i-bp19xem7lt97h973****',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间戳。默认为发起调用前的30天。'."\n"
."\n\n"
."\n",
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1605489195000',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间戳。默认为发起调用时的时间。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1605489235000',
],
],
[
'name' => 'Limit',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。默认值:10。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ACS::ECS::Instance',
],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'description' => '地域ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
[
'name' => 'NextToken',
'in' => 'query',
'schema' => [
'description' => '下一个查询开始的Token。',
'type' => 'string',
'required' => false,
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'ED9CD1B3-286C-4E05-A765-5E1E0B9BC2AB',
],
'ResourceConfigurationTimeline' => [
'description' => '资源配置变更历史。',
'type' => 'object',
'properties' => [
'ConfigurationList' => [
'description' => '资源配置变更历史列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '987654321',
],
'AvailabilityZone' => [
'description' => '可用区。',
'type' => 'string',
'example' => 'cn-hangzhou-h',
],
'CaptureTime' => [
'description' => '配置变更时间戳。',
'type' => 'string',
'example' => '1605316711000',
],
'ConfigurationDiff' => [
'description' => '配置资源关系变更信息。',
'type' => 'string',
'example' => '{\\"ExpiredTime\\":[\\"2020-10-26T16:00Z\\",\\"2020-11-26T16:00Z\\"]}',
],
'Region' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ResourceCreateTime' => [
'description' => '资源创建时间。',
'type' => 'string',
'example' => '1605237751000',
],
'ResourceEventType' => [
'description' => '资源变更事件的类型。取值:'."\n"
."\n"
.'- DISCOVERED:新增资源事件。'."\n"
."\n"
.'- MODIFY:修改资源事件。'."\n"
."\n"
.'- REMOVE:删除资源事件。',
'type' => 'string',
'example' => 'DISCOVERED',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'i-bp19xem7lt97h973****',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'ECS-test',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ACS::ECS::Instance',
],
'Tags' => [
'description' => '资源标签。',
'type' => 'string',
'example' => '"{\\"\\"hc\\"\\":[\\"\\"value2\\"\\"]}"',
],
],
],
],
'Limit' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'NextToken' => [
'description' => '下一个查询开始的Token。',
'type' => 'string',
'example' => 'caeba0bbb2be03f84eb48b699f0a****',
],
'TotalCount' => [
'description' => '资源配置变更历史总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100',
],
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ED9CD1B3-286C-4E05-A765-5E1E0B9BC2AB\\",\\n \\"ResourceConfigurationTimeline\\": {\\n \\"ConfigurationList\\": [\\n {\\n \\"AccountId\\": 987654321,\\n \\"AvailabilityZone\\": \\"cn-hangzhou-h\\",\\n \\"CaptureTime\\": \\"1605316711000\\",\\n \\"ConfigurationDiff\\": \\"{\\\\\\\\\\\\\\"ExpiredTime\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"2020-10-26T16:00Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"2020-11-26T16:00Z\\\\\\\\\\\\\\"]}\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResourceCreateTime\\": \\"1605237751000\\",\\n \\"ResourceEventType\\": \\"DISCOVERED\\",\\n \\"ResourceId\\": \\"i-bp19xem7lt97h973****\\",\\n \\"ResourceName\\": \\"ECS-test\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\",\\n \\"Tags\\": \\"\\\\\\"{\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"hc\\\\\\\\\\\\\\"\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"]}\\\\\\"\\"\\n }\\n ],\\n \\"Limit\\": 10,\\n \\"NextToken\\": \\"caeba0bbb2be03f84eb48b699f0a****\\",\\n \\"TotalCount\\": 100\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\tED9CD1B3-286C-4E05-A765-5E1E0B9BC2AB\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t987654321\\r\\n\\t\\t\\t\\t1605237751000\\r\\n\\t\\t\\t\\tDISCOVERED\\r\\n 1605316711000\\r\\n\\t\\t\\t\\t{\\\\\\"ExpiredTime\\\\\\":[\\\\\\"2020-10-26T16:00Z\\\\\\",\\\\\\"2020-11-26T16:00Z\\\\\\"]}\\r\\n\\t\\t\\t\\ti-bp19xem7lt97h973****\\r\\n\\t\\t\\t\\tECS-test\\r\\n\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\tcn-hangzhou-h\\r\\n\\t\\t\\t\\tACS::ECS::Instance\\r\\n\\t\\t\\t\\t{\\\\\\"\\\\\\"hc\\\\\\"\\\\\\":[\\\\\\"\\\\\\"value2\\\\\\"\\\\\\"]}\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t10\\r\\n\\t\\t\\tcaeba0bbb2be03f84eb48b699f0a****\\r\\n\\t\\t\\r\\n","errorExample":""}]',
'title' => '查询资源配置变更历史',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetDiscoveredResourceSummary' => [
'summary' => '查询监控中的资源概览。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'DiscoveredResourceSummary' => [
'description' => '资源概览。',
'type' => 'object',
'properties' => [
'RegionCount' => [
'description' => '覆盖地域数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '6',
],
'ResourceCount' => [
'description' => '监控中的资源数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '7',
],
'ResourceTypeCount' => [
'description' => '监控中的资源类型数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '45',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '2A8FA4FB-2E08-4D28-8F83-1A8A3EC80B1C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DiscoveredResourceSummary\\": {\\n \\"RegionCount\\": 6,\\n \\"ResourceCount\\": 7,\\n \\"ResourceTypeCount\\": 45\\n },\\n \\"RequestId\\": \\"2A8FA4FB-2E08-4D28-8F83-1A8A3EC80B1C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 45\\n 7\\n 6\\n \\n 2A8FA4FB-2E08-4D28-8F83-1A8A3EC80B1C\\n","errorExample":""}]',
'title' => '查询资源概览',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetSupportedResourceTypes' => [
'summary' => '查询配置审计支持的所有资源类型列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig56XT35',
],
'autoTest' => true,
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '6CE4ABA1-9A57-41A9-8EA9-E8B17D4671CE',
],
'ResourceTypes' => [
'description' => '资源类型列表。',
'type' => 'array',
'items' => [
'description' => '资源类型列表。',
'type' => 'string',
'example' => '["ACS::ECS::Instance","ACS::ECS::NetworkInterface"]',
],
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6CE4ABA1-9A57-41A9-8EA9-E8B17D4671CE\\",\\n \\"ResourceTypes\\": [\\n \\"[\\\\\\"ACS::ECS::Instance\\\\\\",\\\\\\"ACS::ECS::NetworkInterface\\\\\\"]\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\tACS::ECS::Instance\\r\\n\\t\\tACS::ECS::NetworkInterface\\r\\n\\t\\t3A0D65E8-D5C0-4664-B257-950F7A5E33C3\\r\\n","errorExample":""}]',
'title' => '查询配置审计支持的资源类型列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DeleteConfigRules' => [
'summary' => '批量删除指定规则。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'delete',
],
'parameters' => [
[
'name' => 'ConfigRuleIds',
'in' => 'query',
'schema' => [
'description' => '规则ID。多个规则ID之间以英文逗号(,)分隔,且不能超过20个。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cr-2da35180a8d1008e****,cr-2da35180a8d1008e****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperateRuleResult' => [
'description' => '批量删除规则结果。',
'type' => 'object',
'properties' => [
'OperateRuleItemList' => [
'description' => '批量删除规则结果。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-2da35180a8d1008e****',
],
'ErrorCode' => [
'description' => '错误码。'."\n"
."\n"
.'- 当您删除规则成功时,该参数为空。'."\n"
."\n"
.'- 当您删除规则失败时,该参数显示错误码。错误码详情,请参见[错误中心](https://error-center.aliyun.com/status/product/Config)。'."\n"
."\n"
.'- 当您删除规则失败时,该参数显示错误码。错误码详情,请参见[错误中心](https://error-center.alibabacloud.com/status/product/Config)。',
'type' => 'string',
'example' => 'ConfigRuleCanNotDelete',
],
'Success' => [
'description' => '删除规则是否成功。取值:'."\n"
.'- true:成功'."\n"
.'- false: 失败',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '49C1A88F-D163-46DF-84A6-F300229F37AE',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'ConfigRuleCanNotDelete',
'errorMessage' => 'The config rule cannot be deleted.',
],
[
'errorCode' => 'Invalid.ConfigRuleIds.SizeExceed',
'errorMessage' => 'The maximum number of ConfigRuleIds cannot exceed 20.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"49C1A88F-D163-46DF-84A6-F300229F37AE\\",\\n \\"OperateRuleResult\\": {\\n \\"OperateRuleItemList\\": [\\n {\\n \\"ConfigRuleId\\": \\"cr-2da35180a8d1008e****\\",\\n \\"ErrorCode\\": \\"ConfigRuleCanNotDelete\\",\\n \\"Success\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n cr-2da35180a8d1008e****\\n ConfigRuleCanNotDelete\\n false\\n \\n \\n cr-2da351800131233a****\\n \\n true\\n \\n 49C1A88F-D163-46DF-84A6-F300229F37AE\\n \\n","errorExample":""}]',
'title' => '批量删除规则',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'StartConfigRuleEvaluation' => [
'summary' => '使该规则执行一次评估。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ConfigRuleId',
'in' => 'query',
'schema' => [
'description' => '规则ID。'."\n"
."\n"
.'关于如何获取规则ID,请参见[ListConfigRules](~~169607~~)。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'cr-bdb6626622af0012****',
],
],
[
'name' => 'RevertEvaluation',
'in' => 'query',
'schema' => [
'description' => '是否恢复已忽略的评估结果。取值:'."\n"
."\n"
.'- true:恢复已忽略的评估结果。'."\n"
."\n"
.'- false:不恢复已忽略的评估结果。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'CompliancePackId',
'in' => 'query',
'schema' => [
'description' => '合规包ID。'."\n"
."\n"
.'关于如何获取合规包ID,请参见[ListCompliancePacks](~~263332~~)。'."\n"
."\n"
.'> 参数`CompliancePackId`和`ConfigRuleId`必须二选一。',
'type' => 'string',
'required' => false,
'example' => 'cp-ac16626622af0053****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C32EEAD7-BF64-5927-977A-AFF9342B7275',
],
'Result' => [
'description' => '规则执行结果。取值:'."\n"
."\n"
.'- true:成功。'."\n"
."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ConfigRuleNotExists',
'errorMessage' => 'The ConfigRule does not exist.',
],
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C32EEAD7-BF64-5927-977A-AFF9342B7275\\",\\n \\"Result\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n C32EEAD7-BF64-5927-977A-AFF9342B7275\\n true\\n","errorExample":""}]',
'title' => '启用指定规则',
'description' => '> 本接口仅用于触发规则执行一次评估。如果您需要查看规则的本次评估结果,请调用ListConfigRuleEvaluationResults接口。更多信息,请参见[ListConfigRuleEvaluationResults](~~267503~~)。'."\n"
."\n"
.'本文将提供一个示例,使规则`cr-bdb6626622af0012****`执行一次评估。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~169575~~)。',
],
'StopConfigRules' => [
'summary' => '批量停用指定规则,使规则处于“已停用”状态。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ConfigRuleIds',
'in' => 'query',
'schema' => [
'description' => '规则ID。多个规则ID之间以英文逗号(,)分隔,且不能超过20个。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cr-2da35180a8d1008e****,cr-2da35180a8d1008e****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperateRuleResult' => [
'description' => '批量停用规则结果。',
'type' => 'object',
'properties' => [
'OperateRuleItemList' => [
'description' => '批量停用规则结果。',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-2da35180a8d1008e****',
],
'ErrorCode' => [
'description' => '错误码。'."\n"
."\n"
.'- 当您停用规则成功时,该参数为空。'."\n"
."\n"
.'- 当您停用规则失败时,该参数显示错误码。错误码详情,请参见[错误中心](https://error-center.aliyun.com/status/product/Config)。'."\n"
."\n"
.'- 当您停用规则失败时,该参数显示错误码。错误码详情,请参见[错误中心](https://error-center.alibabacloud.com/status/product/Config)。',
'type' => 'string',
'example' => 'ConfigRuleStatusNotActive',
],
'Success' => [
'description' => '停用规则是否成功。取值:'."\n"
."\n"
.'- true:成功'."\n"
."\n"
.'- false: 失败',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '49C1A88F-D163-46DF-84A6-F300229F37AE',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'Invalid.ConfigRuleIds.SizeExceed',
'errorMessage' => 'The maximum number of ConfigRuleIds cannot exceed 20.',
],
[
'errorCode' => 'ConfigRuleStatusNotActive',
'errorMessage' => 'The status of the config rule is not active.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"49C1A88F-D163-46DF-84A6-F300229F37AE\\",\\n \\"OperateRuleResult\\": {\\n \\"OperateRuleItemList\\": [\\n {\\n \\"ConfigRuleId\\": \\"cr-2da35180a8d1008e****\\",\\n \\"ErrorCode\\": \\"ConfigRuleStatusNotActive\\",\\n \\"Success\\": false\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcr-2da35180a8d1008e****\\r\\n\\t\\t\\t\\tConfigRuleStatusNotActive\\r\\n\\t\\t\\t\\tfalse\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcr-2da351800131233a****\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t49C1A88F-D163-46DF-84A6-F300229F37AE\\r\\n\\t\\t\\r\\n","errorExample":""}]',
'title' => '批量停用指定规则',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ListConfigRules' => [
'summary' => '查询当前账号规则列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfigNPMEKB',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ConfigRuleState',
'in' => 'query',
'schema' => [
'description' => '规则的状态。取值:'."\n"
.'- ACTIVE:应用中。'."\n"
.'- EVALUATING:评估中。'."\n"
.'- INACTIVE:已停用。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ACTIVE',
'enum' => [
'ACTIVE',
'DELETING',
'EVALUATING',
'INACTIVE',
],
],
],
[
'name' => 'ComplianceType',
'in' => 'query',
'schema' => [
'description' => '规则的合规类型。取值:'."\n"
.'- COMPLIANT:合规。'."\n"
.'- NON_COMPLIANT:不合规。'."\n"
.'- NOT_APPLICABLE:不适用。'."\n"
.'- INSUFFICIENT_DATA:数据不充分。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'COMPLIANT',
'enum' => [
'COMPLIANT',
'NON_COMPLIANT',
'NOT_APPLICABLE',
'INSUFFICIENT_DATA',
'IGNORED',
],
],
],
[
'name' => 'RiskLevel',
'in' => 'query',
'schema' => [
'description' => '规则的风险等级。取值:'."\n"
.'- 1:高风险。'."\n"
.'- 2:中风险。'."\n"
.'- 3:低风险。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '规则列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '20',
'default' => '10',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'true',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
[
'name' => 'ConfigRuleName',
'in' => 'query',
'schema' => [
'description' => '规则的名称。',
'type' => 'string',
'required' => false,
'example' => 'OSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问',
],
],
[
'name' => 'CompliancePackId',
'in' => 'query',
'schema' => [
'description' => '规则所属的合规包ID。',
'type' => 'string',
'required' => false,
'example' => 'cp-8d5c6457e0d9002a****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ConfigRules' => [
'description' => '规则列表。',
'type' => 'object',
'properties' => [
'ConfigRuleList' => [
'description' => '规则列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '该规则归属的阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '987654321',
],
'AutomationType' => [
'description' => '修正模板类型。取值:LC。'."\n"
."\n"
.'> LC:逻辑编排(Logic Composer)。',
'type' => 'string',
'example' => 'LC',
],
'Compliance' => [
'description' => '规则合规情况统计。',
'type' => 'object',
'properties' => [
'ComplianceType' => [
'description' => '规则合规类型。取值:'."\n"
."\n"
.'- COMPLIANT:合规。'."\n"
."\n"
.'- NON_COMPLIANT:不合规。'."\n"
."\n"
.'- NOT_APPLICABLE:不适用。'."\n"
."\n"
.'- INSUFFICIENT_DATA:数据不充分。',
'type' => 'string',
'example' => 'COMPLIANT',
],
'Count' => [
'description' => '该规则符合指定合规类型的资源数统计。',
'type' => 'integer',
'format' => 'int32',
'example' => '161',
],
],
],
'CompliancePackId' => [
'description' => '规则所属的合规包ID。',
'type' => 'string',
'example' => 'cp-8d5c6457e0d9002a****',
],
'ConfigRuleArn' => [
'description' => '规则ARN。',
'type' => 'string',
'example' => 'acs:config::120886317861****:rule/cr-8d5c6457e0d9002a****',
],
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-8d5c6457e0d9002a****',
],
'ConfigRuleName' => [
'description' => '规则名称。',
'type' => 'string',
'example' => 'OSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问',
],
'ConfigRuleState' => [
'description' => '当前规则运行状态。取值:'."\n"
."\n"
.'- ACTIVE:应用中。'."\n"
."\n"
.'- EVALUATING:评估中。'."\n"
."\n"
.'- INACTIVE:已停用。',
'type' => 'string',
'example' => 'ACTIVE',
],
'CreateBy' => [
'description' => '规则的创建信息。',
'type' => 'object',
'properties' => [
'CompliancePackId' => [
'description' => '合规包ID。',
'type' => 'string',
'example' => 'cp-8d5c6457e0d9002a****',
],
'CompliancePackName' => [
'description' => '合规包名称。',
'type' => 'string',
'example' => 'OSS合规管理最佳实践',
],
],
],
'Description' => [
'description' => '规则的描述信息。',
'type' => 'string',
'example' => 'OSS存储空间的ACL策略禁止公共读访问,视为“合规”。',
],
'RiskLevel' => [
'description' => '规则的风险等级。取值:'."\n"
."\n"
.'- 1:高风险。'."\n"
."\n"
.'- 2:中风险。'."\n"
."\n"
.'- 3:低风险。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'SourceIdentifier' => [
'description' => '规则标识。'."\n"
."\n"
.'- 如果规则使用了托管规则,则该参数为托管规则名称。'."\n"
."\n"
.'- 如果规则使用了自定义函数,则该参数为函数ARN。',
'type' => 'string',
'example' => 'oss-bucket-public-read-prohibited',
],
'SourceOwner' => [
'description' => '规则来源的归属。取值:'."\n"
."\n"
.'- CUSTOM_FC:用户自定义函数。'."\n"
."\n"
.'- ALIYUN:托管规则。',
'type' => 'string',
'example' => 'ALIYUN',
],
'Tags' => [
'description' => '标签。',
'type' => 'array',
'items' => [
'description' => '标签。',
'type' => 'object',
'properties' => [
'Key' => [
'description' => '标签键。',
'type' => 'string',
'example' => 'Key1',
],
'Value' => [
'description' => '标签值。',
'type' => 'string',
'example' => 'Value1',
],
],
],
],
],
],
],
'PageNumber' => [
'description' => '规则列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'example' => '20',
],
'TotalCount' => [
'description' => '规则总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '1',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '8195B664-9565-4685-89AC-8B5F04B44B92',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigRules\\": {\\n \\"ConfigRuleList\\": [\\n {\\n \\"AccountId\\": 987654321,\\n \\"AutomationType\\": \\"LC\\",\\n \\"Compliance\\": {\\n \\"ComplianceType\\": \\"COMPLIANT\\",\\n \\"Count\\": 161\\n },\\n \\"CompliancePackId\\": \\"cp-8d5c6457e0d9002a****\\",\\n \\"ConfigRuleArn\\": \\"acs:config::120886317861****:rule/cr-8d5c6457e0d9002a****\\",\\n \\"ConfigRuleId\\": \\"cr-8d5c6457e0d9002a****\\",\\n \\"ConfigRuleName\\": \\"OSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问\\",\\n \\"ConfigRuleState\\": \\"ACTIVE\\",\\n \\"CreateBy\\": {\\n \\"CompliancePackId\\": \\"cp-8d5c6457e0d9002a****\\",\\n \\"CompliancePackName\\": \\"OSS合规管理最佳实践\\"\\n },\\n \\"Description\\": \\"OSS存储空间的ACL策略禁止公共读访问,视为“合规”。\\",\\n \\"RiskLevel\\": 1,\\n \\"SourceIdentifier\\": \\"oss-bucket-public-read-prohibited\\",\\n \\"SourceOwner\\": \\"ALIYUN\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Key1\\",\\n \\"Value\\": \\"Value1\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1\\n },\\n \\"RequestId\\": \\"8195B664-9565-4685-89AC-8B5F04B44B92\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t8195B664-9565-4685-89AC-8B5F04B44B92\\r\\n\\t\\r\\n\\t\\t1\\r\\n\\t\\t20\\r\\n\\t\\t1\\r\\n\\t\\t\\r\\n\\t\\t\\tcp-8d5c6457e0d9002a****\\r\\n\\t\\t\\tcr-8d5c6457e0d9002a****\\r\\n\\t\\t\\t987654321\\r\\n\\t\\t\\tOSS存储空间的ACL策略禁止公共读访问,视为“合规”。\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tCOMPLIANT\\r\\n\\t\\t\\t\\t161\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tacs:config::120886317861****:rule/cr-8d5c6457e0d9002a****\\r\\n\\t\\t\\tALIYUN\\r\\n\\t\\t\\toss-bucket-public-read-prohibited\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tcp-8d5c6457e0d9002a628b\\r\\n\\t\\t\\t\\tOSS合规管理最佳实践\\r\\n\\t\\t\\t\\t1208863178612953\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tOSS合规管理最佳实践-OSS存储空间ACL禁止公共读访问\\r\\n\\t\\t\\t1\\r\\n\\t\\t\\tACTIVE\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t","errorExample":""}]',
'title' => '查询规则列表',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeEvaluationResults' => [
'summary' => '查询规则的评估结果列表。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。当您按资源类型查询资源评估结果时,必须配置该参数。'."\n"
."\n"
.'您可以通过GetSupportedResourceTypes接口获取配置审计支持的资源类型列表。更多信息,请参见[GetSupportedResourceTypes](~~169618~~)。'."\n"
."\n"
.'> 资源类型(ResourceType)和规则ID(ConfigRuleId)二选一。'."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ACS::ECS::Instance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。当您按资源类型查询资源评估结果时,必须配置该参数。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'i-bp151g9tpto890zr****',
],
],
[
'name' => 'ComplianceType',
'in' => 'query',
'schema' => [
'description' => '合规类型。取值:'."\n"
.'- COMPLIANT:合规。'."\n"
.'- NON_COMPLIANT:不合规。'."\n"
.'- NOT_APPLICABLE:不适用。'."\n"
.'- INSUFFICIENT_DATA:数据不充分。',
'type' => 'string',
'required' => false,
'example' => 'COMPLIANT',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '资源评估结果列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'minimum' => '1',
'example' => '1',
'default' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'docRequired' => false,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
'default' => '10',
],
],
[
'name' => 'ConfigRuleId',
'in' => 'query',
'schema' => [
'description' => '规则ID。当您按规则查询资源评估结果时,必须配置该参数。'."\n"
."\n"
.'> 资源类型(ResourceType)和规则ID(ConfigRuleId)二选一。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'cr-2da35180a8d1008e****',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'EvaluationResults' => [
'description' => '资源评估结果。',
'type' => 'object',
'properties' => [
'EvaluationResultList' => [
'description' => '资源评估结果列表。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'Annotation' => [
'description' => '不合规资源的补充信息。',
'type' => 'string',
'example' => '{"operator": "StringEquals", "property": "$.SslProtocol", "desiredValue": "on", "configuration": "[\'off\']"}',
],
'ComplianceType' => [
'description' => '合规类型。取值:'."\n"
.'- COMPLIANT:合规。'."\n"
.'- NON_COMPLIANT:不合规。'."\n"
.'- NOT_APPLICABLE:不适用。'."\n"
.'- INSUFFICIENT_DATA:数据不充分。'."\n"
."\n",
'type' => 'string',
'example' => 'COMPLIANT',
],
'ConfigRuleInvokedTimestamp' => [
'description' => '调用规则评估资源时的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1589941923258',
],
'EvaluationResultIdentifier' => [
'description' => '资源评估结果标识符。',
'type' => 'object',
'properties' => [
'EvaluationResultQualifier' => [
'description' => '规则评估的资源范围。',
'type' => 'object',
'properties' => [
'ConfigRuleArn' => [
'description' => '规则ARN。',
'type' => 'string',
'example' => 'acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****',
],
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-2da35180a8d1008e****',
],
'ConfigRuleName' => [
'description' => '规则名称。',
'type' => 'string',
'example' => 'ECS实例开启释放保护',
],
'RegionId' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ResourceId' => [
'description' => '规则评估的资源ID。',
'type' => 'string',
'example' => 'i-bp151g9tpto890zr****',
],
'ResourceName' => [
'description' => '规则评估的资源名称。',
'type' => 'string',
'example' => 'launch-advisor-20200330',
],
'ResourceType' => [
'description' => '规则评估的资源类型。',
'type' => 'string',
'example' => 'ACS::ECS::Instance',
],
],
],
'OrderingTimestamp' => [
'description' => '时间轴展示的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1589941923117',
],
],
],
'InvokingEventMessageType' => [
'description' => '规则的触发机制。取值:'."\n"
.'- ConfigurationItemChangeNotification:配置变更。'."\n"
.'- ScheduledNotification:周期执行。',
'type' => 'string',
'example' => 'ConfigurationItemChangeNotification',
],
'RemediationEnabled' => [
'description' => '修正设置是否启用。取值:'."\n"
."\n"
.'- true'."\n"
."\n"
.'- false',
'type' => 'boolean',
'example' => 'false',
],
'ResultRecordedTimestamp' => [
'description' => '资源评估结果的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1589941923432',
],
'RiskLevel' => [
'description' => '风险等级。取值:'."\n"
.'- 1:高风险。'."\n"
.'- 2:中风险。'."\n"
.'- 3:低风险。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'PageNumber' => [
'description' => '资源评估结果列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '资源评估结果的总记录数。'."\n",
'type' => 'integer',
'format' => 'int64',
'example' => '2',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'D296EE41-1143-4B13-83BB-909008100130',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'CloudConfigServiceRoleNotExisted',
'errorMessage' => 'The CloudConfigServiceRole does not exist.',
],
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"EvaluationResults\\": {\\n \\"EvaluationResultList\\": [\\n {\\n \\"Annotation\\": \\"{\\\\\\"operator\\\\\\": \\\\\\"StringEquals\\\\\\", \\\\\\"property\\\\\\": \\\\\\"$.SslProtocol\\\\\\", \\\\\\"desiredValue\\\\\\": \\\\\\"on\\\\\\", \\\\\\"configuration\\\\\\": \\\\\\"[\'off\']\\\\\\"}\\",\\n \\"ComplianceType\\": \\"COMPLIANT\\",\\n \\"ConfigRuleInvokedTimestamp\\": 1589941923258,\\n \\"EvaluationResultIdentifier\\": {\\n \\"EvaluationResultQualifier\\": {\\n \\"ConfigRuleArn\\": \\"acs:config::120390217529****:config-rule/cr-2da35180a8d1008e****\\",\\n \\"ConfigRuleId\\": \\"cr-2da35180a8d1008e****\\",\\n \\"ConfigRuleName\\": \\"ECS实例开启释放保护\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ResourceId\\": \\"i-bp151g9tpto890zr****\\",\\n \\"ResourceName\\": \\"launch-advisor-20200330\\",\\n \\"ResourceType\\": \\"ACS::ECS::Instance\\"\\n },\\n \\"OrderingTimestamp\\": 1589941923117\\n },\\n \\"InvokingEventMessageType\\": \\"ConfigurationItemChangeNotification\\",\\n \\"RemediationEnabled\\": false,\\n \\"ResultRecordedTimestamp\\": 1589941923432,\\n \\"RiskLevel\\": 1\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2\\n },\\n \\"RequestId\\": \\"D296EE41-1143-4B13-83BB-909008100130\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tD296EE41-1143-4B13-83BB-909008100130\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1608262263084\\r\\n\\t\\t\\tCOMPLIANT\\r\\n\\t\\t\\t1608262263321\\r\\n\\t\\t\\tConfigurationItemChangeNotification\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tcr-22726457e0d90078****\\r\\n\\t\\t\\t\\t\\tacs:config::120886317861****:config-rule/cr-22726457e0d90078****\\r\\n\\t\\t\\t\\t\\ti-t4n0piq1mkfo1d27****\\r\\n\\t\\t\\t\\t\\tECS实例开启释放保护\\r\\n\\t\\t\\t\\t\\tACS::ECS::Instance\\r\\n\\t\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t1608262263084\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1608262263084\\r\\n\\t\\t\\tCOMPLIANT\\r\\n\\t\\t\\t1608262263326\\r\\n\\t\\t\\tConfigurationItemChangeNotification\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\tcr-22726457e0d90078****\\r\\n\\t\\t\\t\\t\\tacs:config::120886317861****:config-rule/cr-22726457e0d90078****\\r\\n\\t\\t\\t\\t\\ti-2ze5o2beycwbvqnx****\\r\\n\\t\\t\\t\\t\\tECS实例开启释放保护\\r\\n\\t\\t\\t\\t\\tACS::ECS::Instance\\r\\n\\t\\t\\t\\t\\tcn-hangzhou\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t1608262263084\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t3\\r\\n\\t\\t\\tfalse\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t52\\r\\n\\t\\t10\\r\\n\\t\\t1\\r\\n\\t\\r\\n\\t","errorExample":""}]',
'title' => '查询规则评估结果',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeCompliance' => [
'summary' => '查询资源的合规结果统计。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。'."\n"
."\n"
.'当您按资源维度查询资源评估结果时,必须配置参数ResourceType和ResourceId。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'ACS::ECS::Instance',
],
],
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。'."\n"
."\n"
.'当您按资源维度查询资源评估结果时,必须配置参数ResourceType和ResourceId。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'i-bp151g9tpto890zr****',
],
],
[
'name' => 'ComplianceType',
'in' => 'query',
'schema' => [
'description' => '合规类型。取值:'."\n"
.'- COMPLIANT:合规。'."\n"
.'- NON_COMPLIANT:不合规。'."\n"
.'- NOT_APPLICABLE:不适用。'."\n"
.'- INSUFFICIENT_DATA:数据不充分。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'COMPLIANT',
'enum' => [
'COMPLIANT',
'NON_COMPLIANT',
'NOT_APPLICABLE',
'INSUFFICIENT_DATA',
],
],
],
[
'name' => 'ConfigRuleId',
'in' => 'query',
'schema' => [
'description' => '规则ID。'."\n"
."\n"
.'当您按规则维度查询资源评估结果时,必须同时配置参数ConfigRuleId、ResourceType和ResourceId,否则ConfigRuleId无效。',
'type' => 'string',
'required' => false,
'example' => 'cr-12b398b633820012****',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100931896542****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '合规统计结果。',
'type' => 'object',
'properties' => [
'ComplianceResult' => [
'description' => '合规结果统计。',
'type' => 'object',
'properties' => [
'Compliances' => [
'description' => '资源合规结果统计。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ComplianceType' => [
'description' => '合规类型。取值:'."\n"
."\n"
.'- COMPLIANT:合规。'."\n"
."\n"
.'- NON_COMPLIANT:不合规。'."\n"
."\n"
.'- NOT_APPLICABLE:不适用。'."\n"
."\n"
.'- INSUFFICIENT_DATA:无数据。',
'type' => 'string',
'example' => 'COMPLIANT',
],
'Count' => [
'description' => '指定合规类型的数量统计。'."\n"
."\n"
.'- 当入参指定ResourceId时,该参数为资源数统计值。'."\n"
."\n"
.'- 当入参指定ConfigRuleId时,该参数为规则数统计值。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
],
],
],
'TotalCount' => [
'description' => '所有合规类型的数量统计。'."\n"
."\n"
.'- 当入参指定ResourceId时,该参数为资源数量统计值。'."\n"
."\n"
.'- 当入参指定ConfigRuleId时,该参数为规则数量统计值。',
'type' => 'integer',
'format' => 'int64',
'example' => '12',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '17306AB1-34E0-468F-BD7B-68D8AEAB754F',
],
],
],
],
],
'errorCodes' => [
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ComplianceResult\\": {\\n \\"Compliances\\": [\\n {\\n \\"ComplianceType\\": \\"COMPLIANT\\",\\n \\"Count\\": 12\\n }\\n ],\\n \\"TotalCount\\": 12\\n },\\n \\"RequestId\\": \\"17306AB1-34E0-468F-BD7B-68D8AEAB754F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 17306AB1-34E0-468F-BD7B-68D8AEAB754F\\n \\n \\n NOT_APPLICABLE\\n 0\\n \\n \\n NON_COMPLIANT\\n 5\\n \\n \\n INSUFFICIENT_DATA\\n 0\\n \\n \\n COMPLIANT\\n 13\\n \\n \\n","errorExample":""}]',
'title' => '查询合规结果统计',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeComplianceSummary' => [
'summary' => '查询当前账号的合规结果统计概要。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '100931896542****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '合规统计结果。',
'type' => 'object',
'properties' => [
'ComplianceSummary' => [
'description' => '合规结果统计概要。',
'type' => 'object',
'properties' => [
'ComplianceSummaryByConfigRule' => [
'description' => '规则维度的合规结果统计概要。',
'type' => 'object',
'properties' => [
'ComplianceSummaryTimestamp' => [
'description' => '合规结果统计的时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1589853712165',
],
'CompliantCount' => [
'description' => '合规的规则数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '101',
],
'NonCompliantCount' => [
'description' => '不合规的规则数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'TotalCount' => [
'description' => '规则总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '113',
],
],
],
'ComplianceSummaryByResource' => [
'description' => '资源维度的合规结果统计概要。',
'type' => 'object',
'properties' => [
'ComplianceSummaryTimestamp' => [
'description' => '合规结果统计的时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1589853712165',
],
'CompliantCount' => [
'description' => '合规的资源数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'NonCompliantCount' => [
'description' => '不合规的资源数量。',
'type' => 'integer',
'format' => 'int32',
'example' => '12',
],
'TotalCount' => [
'description' => '资源总数。',
'type' => 'integer',
'format' => 'int64',
'example' => '13',
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'CAEE6F34-DEDC-4AAA-AA8C-946D5D008735',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ComplianceSummary\\": {\\n \\"ComplianceSummaryByConfigRule\\": {\\n \\"ComplianceSummaryTimestamp\\": 1589853712165,\\n \\"CompliantCount\\": 101,\\n \\"NonCompliantCount\\": 12,\\n \\"TotalCount\\": 113\\n },\\n \\"ComplianceSummaryByResource\\": {\\n \\"ComplianceSummaryTimestamp\\": 1589853712165,\\n \\"CompliantCount\\": 1,\\n \\"NonCompliantCount\\": 12,\\n \\"TotalCount\\": 13\\n }\\n },\\n \\"RequestId\\": \\"CAEE6F34-DEDC-4AAA-AA8C-946D5D008735\\"\\n}","errorExample":""},{"type":"xml","example":"\\n CAEE6F34-DEDC-4AAA-AA8C-946D5D008735\\n \\n \\n 29\\n 581\\n 1589853712165\\n \\n \\n 79\\n 1\\n 34\\n 1589853712128\\n \\n \\n 200\\n true\\n","errorExample":""}]',
'title' => '查询合规结果统计概要',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeConfigRule' => [
'summary' => '查询指定的规则详情。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'ConfigRuleId',
'in' => 'query',
'schema' => [
'description' => '规则ID。关于如何查询规则ID,请参见[ListConfigRules](~~169607~~)。 ',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cr-7bc06457e0d90041****',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ConfigRule' => [
'description' => '规则详情。',
'type' => 'object',
'properties' => [
'ConfigRuleArn' => [
'description' => '规则ARN。',
'type' => 'string',
'example' => 'acs:config::120886317861****:rule/cr-7bc06457e0d90041****',
],
'ConfigRuleEvaluationStatus' => [
'description' => '资源评估状态。',
'type' => 'object',
'properties' => [
'FirstActivatedTimestamp' => [
'description' => '首次激活时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1618901952341',
],
'FirstEvaluationStarted' => [
'description' => '规则是否已执行过评估。取值:'."\n"
.'- true(默认值)'."\n"
.'- false ',
'type' => 'boolean',
'example' => 'true',
],
'LastErrorCode' => [
'description' => '规则最近一次执行的错误码。',
'type' => 'string',
'example' => 'FunctionNotFound',
],
'LastErrorMessage' => [
'description' => '规则最近一次执行的错误信息。',
'type' => 'string',
'example' => 'function \'funtionName\' does not exist in service \'serviceName\'',
],
'LastFailedEvaluationTimestamp' => [
'description' => '规则最近一次调用失败的结束时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602819143913',
],
'LastFailedInvocationTimestamp' => [
'description' => '规则最近一次调用失败的开始时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602819143910',
],
'LastSuccessfulEvaluationTimestamp' => [
'description' => '规则最近一次调用成功的结束时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1618901957876',
],
'LastSuccessfulInvocationTimestamp' => [
'description' => '规则最近一次调用成功的开始时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1618901957395',
],
],
],
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-7bc06457e0d90041****',
],
'ConfigRuleName' => [
'description' => '规则名称。',
'type' => 'string',
'example' => 'RDS实例CPU核数满足最低要求',
],
'ConfigRuleState' => [
'description' => '当前规则的运行状态。取值:'."\n"
.'- ACTIVE:应用中。'."\n"
.'- EVALUATING:评估中。'."\n"
.'- INACTIVE:已停用。',
'type' => 'string',
'example' => 'ACTIVE',
],
'CreateTimestamp' => [
'description' => '创建规则时的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602818964884',
],
'Description' => [
'description' => '规则的描述信息。',
'type' => 'string',
'example' => 'RDS实例的CPU核数大于等于设置的阈值,视为“合规”。',
],
'InputParameters' => [
'description' => '规则入参。',
'type' => 'object',
'example' => '{"cpuCount": "2" }',
],
'ManagedRule' => [
'description' => '托管规则详情。',
'type' => 'object',
'properties' => [
'CompulsoryInputParameterDetails' => [
'description' => '托管规则必填参数的信息。',
'type' => 'object',
'example' => '{"cpuCount": {"defaultValue": "2","type": "integer"}',
],
'Description' => [
'description' => '托管规则的描述信息。',
'type' => 'string',
'example' => 'RDS实例的CPU核数大于等于设置的阈值,视为“合规”。',
],
'Identifier' => [
'description' => '托管规则的标识符。',
'type' => 'string',
'example' => 'rds-cpu-min-count-limit',
],
'Labels' => [
'description' => '无。',
'type' => 'array',
'items' => [
'description' => '托管规则的标签列表。',
'type' => 'string',
'example' => '["RDS","CPU"]',
],
],
'ManagedRuleName' => [
'description' => '托管规则的名称。',
'type' => 'string',
'example' => 'rds-cpu-min-count-limit',
],
'OptionalInputParameterDetails' => [
'description' => '托管规则可选参数的描述信息。',
'type' => 'object',
'example' => '{"tag1Value":{"type":"string","defaultValue":""},"tag2Key":{"type":"string","defaultValue":""}}',
],
'SourceDetails' => [
'description' => '托管规则详情。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'EventSource' => [
'description' => '规则的事件来源。'."\n"
."\n"
.'> 目前仅支持配置审计事件:aliyun.config。',
'type' => 'string',
'example' => 'aliyun.config',
],
'MaximumExecutionFrequency' => [
'description' => '规则的执行周期。取值:'."\n"
."\n"
.'- One_Hour:1小时。'."\n"
."\n"
.'- Three_Hours:3小时。'."\n"
."\n"
.'- Six_Hours:6小时。'."\n"
."\n"
.'- Twelve_Hours:12小时。'."\n"
."\n"
.'- TwentyFour_Hours:24小时。',
'type' => 'string',
'example' => 'Six_Hours',
],
'MessageType' => [
'description' => '规则的触发机制。取值:'."\n"
.'- ConfigurationItemChangeNotification:配置变更。'."\n"
.'- ScheduledNotification:周期执行。',
'type' => 'string',
'example' => 'ConfigurationItemChangeNotification',
],
],
],
],
],
],
'MaximumExecutionFrequency' => [
'description' => '规则的执行周期。取值:'."\n"
."\n"
.'- One_Hour:1小时。'."\n"
."\n"
.'- Three_Hours:3小时。'."\n"
."\n"
.'- Six_Hours:6小时。'."\n"
."\n"
.'- Twelve_Hours:12小时。'."\n"
."\n"
.'- TwentyFour_Hours:24小时。',
'type' => 'string',
'example' => 'Six_Hours',
],
'ModifiedTimestamp' => [
'description' => '规则最近一次修改的时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1602992721000',
],
'RiskLevel' => [
'description' => '规则的风险等级。取值:'."\n"
.'- 1:高风险。'."\n"
.'- 2:中风险。'."\n"
.'- 3:低风险。',
'type' => 'integer',
'format' => 'int32',
'example' => '3',
],
'Scope' => [
'description' => '规则的监控范围。',
'type' => 'object',
'properties' => [
'ComplianceResourceId' => [
'description' => '待评估资源ID。',
'type' => 'string',
'example' => 'vpc-6weoy5flv41pj4wvr****',
],
'ComplianceResourceTypes' => [
'description' => '无。',
'type' => 'array',
'items' => [
'description' => '待评估资源类型列表。'."\n",
'type' => 'string',
'example' => '["ACS::RDS::DBInstance"]',
],
],
],
],
'Source' => [
'description' => '规则执行逻辑的来源信息。',
'type' => 'object',
'properties' => [
'Identifier' => [
'description' => '规则标识。'."\n"
."\n"
.'- 如果规则使用了托管规则,则该参数为托管规则名称。'."\n"
."\n"
.'- 如果规则使用了自定义函数,则该参数为函数ARN。'."\n"
."\n\n",
'type' => 'string',
'example' => 'rds-cpu-min-count-limit',
],
'Owner' => [
'description' => '规则来源的归属。取值:'."\n"
."\n"
.'- CUSTOM_FC:用户自定义函数。'."\n"
."\n"
.'- ALIYUN:托管规则。',
'type' => 'string',
'example' => 'ALIYUN',
],
'SourceConditions' => [
'description' => '规则的配置条件。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'DesiredValue' => [
'description' => '规则入参的期望值。',
'type' => 'string',
'example' => '2',
],
'Name' => [
'description' => '规则入参的名称。',
'type' => 'string',
'example' => 'cpuCount',
],
'Operator' => [
'description' => '规则入参的操作符。通过SelectPath获取到的不同数据类型,对应不同的操作符。 '."\n"
."\n"
.'- 当数据类型为String时,取值:'."\n"
.' - StringEquals:等于。'."\n"
.' - NotStringEquals:不等于。'."\n"
.' - StringIn:存在。'."\n"
.' - NotStringIn:不存在。'."\n"
.' - StringContains:包含。'."\n"
.' - NotStringContains:不包含。'."\n"
."\n"
.'- 当数据类型为Number时,取值:'."\n"
.' - Equals:等于。'."\n"
.' - NotEquals:不等于。'."\n"
.' - Less:小于。'."\n"
.' - LessOrEquals:小于等于。'."\n"
.' - Greater:大于。'."\n"
.' - GreaterOrEquals:大于等于。'."\n"
."\n"
.'- 当数据类型为基于Base64进制编码的Base64 String时,取值:'."\n"
.' - Base64Contains:包含。'."\n"
.' - NotBase64Contains:不包含。'."\n"
.' - Base64ContainsAll:包含全部。'."\n"
.' - Base64ExcludeAll:排除全部。 '."\n"
."\n"
.'- 当数据类型为Array时,取值:'."\n"
.' - Contains:包含。'."\n"
.' - NotContains:不包含。'."\n"
.' - In:存在。'."\n"
.' - NotIn:不存在。'."\n"
.' - ContainsAll:包含全部。'."\n"
.' - ExcludeAll:排除全部。 '."\n"
.' - IsEmpty:为空。 ',
'type' => 'string',
'example' => 'GreaterOrEquals',
],
'Tips' => [
'description' => '参数的提示信息。',
'type' => 'string',
'example' => '实例的状态',
],
],
],
],
'SourceDetails' => [
'description' => '规则来源详情。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'EventSource' => [
'description' => '事件来源。'."\n"
."\n"
.'> 目前仅支持配置审计事件:aliyun.config。',
'type' => 'string',
'example' => 'aliyun.config',
],
'MaximumExecutionFrequency' => [
'description' => '规则的执行周期。取值:'."\n"
."\n"
.'- One_Hour:1小时。'."\n"
."\n"
.'- Three_Hours:3小时。'."\n"
."\n"
.'- Six_Hours:6小时。'."\n"
."\n"
.'- Twelve_Hours:12小时。'."\n"
."\n"
.'- TwentyFour_Hours:24小时。',
'type' => 'string',
'example' => 'Six_Hours',
],
'MessageType' => [
'description' => '规则的触发机制。取值:'."\n"
.'- ConfigurationItemChangeNotification:配置变更。'."\n"
.'- ScheduledNotification:周期执行。',
'type' => 'string',
'example' => 'ConfigurationItemChangeNotification',
],
],
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ConfigRuleNotExists',
'errorMessage' => 'The ConfigRule does not exist.',
],
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigRule\\": {\\n \\"ConfigRuleArn\\": \\"acs:config::120886317861****:rule/cr-7bc06457e0d90041****\\",\\n \\"ConfigRuleEvaluationStatus\\": {\\n \\"FirstActivatedTimestamp\\": 1618901952341,\\n \\"FirstEvaluationStarted\\": true,\\n \\"LastErrorCode\\": \\"FunctionNotFound\\",\\n \\"LastErrorMessage\\": \\"function \'funtionName\' does not exist in service \'serviceName\'\\",\\n \\"LastFailedEvaluationTimestamp\\": 1602819143913,\\n \\"LastFailedInvocationTimestamp\\": 1602819143910,\\n \\"LastSuccessfulEvaluationTimestamp\\": 1618901957876,\\n \\"LastSuccessfulInvocationTimestamp\\": 1618901957395\\n },\\n \\"ConfigRuleId\\": \\"cr-7bc06457e0d90041****\\",\\n \\"ConfigRuleName\\": \\"RDS实例CPU核数满足最低要求\\",\\n \\"ConfigRuleState\\": \\"ACTIVE\\",\\n \\"CreateTimestamp\\": 1602818964884,\\n \\"Description\\": \\"RDS实例的CPU核数大于等于设置的阈值,视为“合规”。\\",\\n \\"InputParameters\\": {\\n \\"cpuCount\\": \\"2\\"\\n },\\n \\"ManagedRule\\": {\\n \\"CompulsoryInputParameterDetails\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Description\\": \\"RDS实例的CPU核数大于等于设置的阈值,视为“合规”。\\",\\n \\"Identifier\\": \\"rds-cpu-min-count-limit\\",\\n \\"Labels\\": [\\n \\"[\\\\\\"RDS\\\\\\",\\\\\\"CPU\\\\\\"]\\"\\n ],\\n \\"ManagedRuleName\\": \\"rds-cpu-min-count-limit\\",\\n \\"OptionalInputParameterDetails\\": {\\n \\"tag1Value\\": {\\n \\"type\\": \\"string\\",\\n \\"defaultValue\\": \\"\\"\\n },\\n \\"tag2Key\\": {\\n \\"type\\": \\"string\\",\\n \\"defaultValue\\": \\"\\"\\n }\\n },\\n \\"SourceDetails\\": [\\n {\\n \\"EventSource\\": \\"aliyun.config\\",\\n \\"MaximumExecutionFrequency\\": \\"Six_Hours\\",\\n \\"MessageType\\": \\"ConfigurationItemChangeNotification\\"\\n }\\n ]\\n },\\n \\"MaximumExecutionFrequency\\": \\"Six_Hours\\",\\n \\"ModifiedTimestamp\\": 1602992721000,\\n \\"RiskLevel\\": 3,\\n \\"Scope\\": {\\n \\"ComplianceResourceId\\": \\"vpc-6weoy5flv41pj4wvr****\\",\\n \\"ComplianceResourceTypes\\": [\\n \\"[\\\\\\"ACS::RDS::DBInstance\\\\\\"]\\"\\n ]\\n },\\n \\"Source\\": {\\n \\"Identifier\\": \\"rds-cpu-min-count-limit\\",\\n \\"Owner\\": \\"ALIYUN\\",\\n \\"SourceConditions\\": [\\n {\\n \\"DesiredValue\\": \\"2\\",\\n \\"Name\\": \\"cpuCount\\",\\n \\"Operator\\": \\"GreaterOrEquals\\",\\n \\"Tips\\": \\"实例的状态\\"\\n }\\n ],\\n \\"SourceDetails\\": [\\n {\\n \\"EventSource\\": \\"aliyun.config\\",\\n \\"MaximumExecutionFrequency\\": \\"Six_Hours\\",\\n \\"MessageType\\": \\"ConfigurationItemChangeNotification\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"A68DD98C-DE65-46AC-B2D2-04A4A9AB5B99\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\tA68DD98C-DE65-46AC-B2D2-04A4A9AB5B99\\r\\n\\t\\r\\n\\t\\t\\r\\n\\t\\t\\trds-cpu-min-count-limit\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tRDS实例的CPU核数大于等于设置的阈值,视为“合规”。\\r\\n\\t\\t\\trds-cpu-min-count-limit\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\t\\t2\\r\\n\\t\\t\\t\\t\\tinteger\\r\\n\\t\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\tRDS\\r\\n\\t\\t\\tCPU\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\taliyun.config\\r\\n\\t\\t\\t\\tConfigurationItemChangeNotification\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\r\\n\\t\\t\\t1618901952341\\r\\n\\t\\t\\t1618901957876\\r\\n\\t\\t\\ttrue\\r\\n\\t\\t\\t1618901957395\\r\\n\\t\\t\\r\\n\\t\\tACTIVE\\r\\n\\t\\t\\r\\n\\t\\t\\tALIYUN\\r\\n\\t\\t\\trds-cpu-min-count-limit\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\tGreaterOrEquals\\r\\n\\t\\t\\t\\t2\\r\\n\\t\\t\\t\\ttrue\\r\\n\\t\\t\\t\\t$.DBInstanceCPU\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\r\\n\\t\\t\\t\\taliyun.config\\r\\n\\t\\t\\t\\tConfigurationItemChangeNotification\\r\\n\\t\\t\\t\\r\\n\\t\\t\\r\\n\\t\\tfalse\\r\\n\\t\\tcr-7bc06457e0d90041****\\r\\n\\t\\t\\r\\n\\t\\t\\tACS::RDS::DBInstance\\r\\n\\t\\t\\r\\n\\t\\tacs:config::120886317861****:rule/cr-7bc06457e0d90041****\\r\\n\\t\\tRDS实例CPU核数满足最低要求\\r\\n\\t\\t3\\r\\n\\t\\t\\r\\n\\t\\t\\t2\\r\\n\\t\\t\\r\\n\\t\\r\\n\\t","errorExample":""}]',
'title' => '查询规则详情',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PutConfigRule' => [
'summary' => '为当前账号新建或修改规则。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ConfigRuleId',
'in' => 'formData',
'schema' => [
'description' => '规则ID。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'cr-2a914fcf617e00c9****',
],
],
[
'name' => 'ConfigRuleName',
'in' => 'formData',
'schema' => [
'description' => '规则名称。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'RDS实例CPU核数满足最低要求',
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => [
'description' => '规则的描述信息。',
'type' => 'string',
'required' => false,
'example' => 'RDS实例的CPU核数大于等于设置的阈值,视为“合规”。',
],
],
[
'name' => 'InputParameters',
'in' => 'formData',
'schema' => [
'description' => '规则入参。',
'type' => 'string',
'required' => false,
'example' => '{"cpuCount": "2"}',
],
],
[
'name' => 'SourceOwner',
'in' => 'formData',
'schema' => [
'description' => '规则来源的归属。取值:'."\n"
.'- CUSTOM_FC:用户自定义函数。'."\n"
.'- ALIYUN:托管规则。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ALIYUN',
'enum' => [
'ALIYUN',
'CUSTOM_FC',
],
],
],
[
'name' => 'SourceIdentifier',
'in' => 'formData',
'schema' => [
'description' => '规则标识。'."\n"
."\n"
.'- 如果规则使用了托管规则,则该参数为规则标识。'."\n"
."\n"
.'- 如果规则使用了自定义函数,则该参数为函数ARN。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'rds-cpu-min-count-limit',
],
],
[
'name' => 'SourceDetailMessageType',
'in' => 'formData',
'schema' => [
'description' => '规则的触发机制。取值:'."\n"
.'- ConfigurationItemChangeNotification:配置变更。'."\n"
.'- ScheduledNotification:周期执行。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ConfigurationItemChangeNotification',
],
],
[
'name' => 'SourceMaximumExecutionFrequency',
'in' => 'formData',
'schema' => [
'description' => '规则执行周期。取值:'."\n"
.'- One_Hour:1小时。'."\n"
.'- Three_Hours:3小时。'."\n"
.'- Six_Hours:6小时。'."\n"
.'- Twelve_Hours:12小时。'."\n"
.'- TwentyFour_Hours:24小时。',
'type' => 'string',
'required' => false,
'example' => 'Twelve_Hours',
'enum' => [
'One_Hour',
'Three_Hours',
'Six_Hours',
'Twelve_Hours',
'TwentyFour_Hours',
],
],
],
[
'name' => 'ScopeComplianceResourceId',
'in' => 'formData',
'schema' => [
'description' => '待评估资源ID。'."\n"
."\n"
.'- 如果为空,则该规则评估ScopeComplianceResourceTypes指定的所有资源类型。'."\n"
."\n"
.'- 如果不为空,则该规则评估指定的资源。',
'type' => 'string',
'required' => false,
'example' => 'vpc-6weoy5flv41pj4wvr****',
],
],
[
'name' => 'ScopeComplianceResourceTypes',
'in' => 'formData',
'schema' => [
'description' => '待评估的资源类型列表。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '["ACS::RDS::DBInstance"]',
],
],
[
'name' => 'RiskLevel',
'in' => 'formData',
'schema' => [
'description' => '风险等级。取值:'."\n"
.'- 1:高风险。'."\n"
.'- 2:中风险。'."\n"
.'- 3:低风险。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'example' => '1',
'enum' => [
'1',
'2',
'3',
],
],
],
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'example' => '1594295238-f9361358-5843-4294-8d30-b5183fac****',
],
],
[
'name' => 'MultiAccount',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
[
'name' => 'MemberId',
'in' => 'query',
'schema' => [
'description' => '该参数计划于2021年06月30日00时00分00秒前下线,其替代功能账号组的API将于2021年05月30日00时00分00秒前上线。如果您正在使用该参数,建议您在2021年05月30日00时00分00秒之后切换为账号组的API。关于账号组,请参见[账号组](~~211534~~)。 ',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '123456789',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-76ac4fcfb57e00c9****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'ExceedMaxRuleCount',
'errorMessage' => 'The maximum number of rules is exceeded.',
],
[
'errorCode' => 'ConfigRuleNotExists',
'errorMessage' => 'The ConfigRule does not exist.',
],
[
'errorCode' => 'ConfigRuleExists',
'errorMessage' => 'The ConfigRule already exists.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::CreateConfigRule',
'Config::2020-09-07::CreateAggregateConfigRule',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigRuleId\\": \\"cr-76ac4fcfb57e00c9****\\",\\n \\"RequestId\\": \\"A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tcr-76ac4fcfb57e00c9****\\n\\tA7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7\\n","errorExample":""}]',
'title' => '新建或修改规则',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PutEvaluations' => [
'summary' => '提交规则评估结果。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ResultToken',
'in' => 'formData',
'schema' => [
'description' => '回调令牌。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => '=lAUbfkWp7GL9AFoQEIStinqBMc4FC8sHvip/1F1npkWUDNS2GEm6xwL6Zl/fSr0bbkWY+aiCLjTJxnp4H/yp/8p/Q8VCAtqG5uhRii4sfnYRnTPnE****',
],
],
[
'name' => 'Evaluations',
'in' => 'formData',
'schema' => [
'description' => '评估结果。',
'type' => 'string',
'required' => false,
'example' => '[{"annotation":"Resource type is ACS::CEN::Flowlog, not in ACS::ECS::Instance,ACS::ECS::NetworkInterface.","complianceResourceId":"flowlog-o6wdfo1yvgo4i8****","complianceResourceType":"ACS::CEN::Flowlog","complianceType":"NOT_APPLICABLE","orderingTimestamp":1588907220408}]',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7',
],
'Result' => [
'description' => '执行状态。取值:'."\n"
."\n"
.'- true:成功'."\n"
."\n"
.'- false:失败',
'type' => 'boolean',
'example' => 'true',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::PutEvaluations',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A7A0FFF8-0B44-40C6-8BBF-3A185EFDF3F7\\n true\\n","errorExample":""}]',
'title' => '提交评估结果',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'ActiveConfigRules' => [
'summary' => '批量启用指定的规则,使得规则状态处于“应用中”。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
],
'parameters' => [
[
'name' => 'ConfigRuleIds',
'in' => 'query',
'schema' => [
'description' => '规则ID。'."\n"
."\n"
.'多个规则ID之间以半角逗号(,)分隔,且不能超过20个。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cr-2da35180a8d1008e****,cr-2da35180a8d1008e****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'OperateRuleResult' => [
'description' => '批量启用规则结果。',
'type' => 'object',
'properties' => [
'OperateRuleItemList' => [
'description' => '批量启用规则结果。',
'type' => 'array',
'items' => [
'description' => '批量启用规则结果。',
'type' => 'object',
'properties' => [
'ConfigRuleId' => [
'description' => '规则ID。',
'type' => 'string',
'example' => 'cr-2da35180a8d1008e****',
],
'ErrorCode' => [
'description' => '错误码。'."\n"
."\n"
.'- 当您启用规则成功时,该参数为空。'."\n"
."\n"
.'- 当您启用规则失败时,该参数显示错误码。错误码详情,请参见[错误中心](https://error-center.aliyun.com/status/product/Config)[错误中心](https://error-center.alibabacloud.com/status/product/Config)。',
'type' => 'string',
'example' => 'ConfigRuleStatusNotInActive',
],
'Success' => [
'description' => '启用规则是否成功。取值:'."\n"
.'- true:成功。'."\n"
.'- false:失败。',
'type' => 'boolean',
'example' => 'false',
],
],
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '49C1A88F-D163-46DF-84A6-F300229F37AE',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'Invalid.ConfigRuleIds.SizeExceed',
'errorMessage' => 'The maximum number of ConfigRuleIds cannot exceed 20.',
],
[
'errorCode' => 'ConfigRuleStatusNotInActive',
'errorMessage' => 'The status of the config rule is not inactive.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::ActiveConfigRules',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"OperateRuleResult\\": {\\n \\"OperateRuleItemList\\": [\\n {\\n \\"ConfigRuleId\\": \\"cr-2da35180a8d1008e****\\",\\n \\"ErrorCode\\": \\"ConfigRuleStatusNotInActive\\",\\n \\"Success\\": false\\n }\\n ]\\n },\\n \\"RequestId\\": \\"49C1A88F-D163-46DF-84A6-F300229F37AE\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n cr-2da35180a8d1008e****\\n ConfigRuleStatusNotInActive\\n false\\n \\n \\n cr-2da351800131233a****\\n \\n true\\n \\n 49C1A88F-D163-46DF-84A6-F300229F37AE\\n \\n","errorExample":""}]',
'title' => '批量启用指定规则',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'StartConfigurationRecorder' => [
'summary' => '设置当前账号的资源监控范围。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfigI0TIO6',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'EnterpriseEdition',
'in' => 'formData',
'schema' => [
'description' => '是否升级企业版配置审计。取值:'."\n"
.'- true'."\n"
.'- false(默认值)'."\n"
."\n"
.'> 企业版配置审计升级为账号组。更多信息,请参见[公告:企业版配置审计升级为账号组](~~213433~~)。',
'type' => 'boolean',
'required' => false,
'example' => 'false',
'default' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ConfigurationRecorder' => [
'description' => '资源监控信息。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '阿里云账号ID。'."\n"
."\n"
.'> 仅当普通账号调用该接口时,返回该参数。',
'type' => 'integer',
'format' => 'int64',
'example' => '120886317861****',
],
'ConfigurationRecorderStatus' => [
'description' => '资源监控状态。取值:'."\n"
.'- REGISTRABLE:未注册。'."\n"
.'- BUILDING:构建中。'."\n"
.'- REGISTERED:已注册。'."\n"
.'- REBUILDING:重新构建中。',
'type' => 'string',
'example' => 'REGISTRABLE',
],
'OrganizationEnableStatus' => [
'description' => '企业版配置审计升级状态。取值:'."\n"
.'- REGISTRABLE:未升级。'."\n"
.'- BUILDING:升级中。'."\n"
.'- REGISTERED:已升级。'."\n",
'type' => 'string',
'example' => 'REGISTRABLE',
],
'OrganizationMasterId' => [
'description' => '企业管理账号ID。'."\n"
."\n"
.'> 仅当企业管理账号调用该接口时,返回该参数。',
'type' => 'integer',
'format' => 'int64',
'example' => '100931896542****',
],
'ResourceTypes' => [
'description' => '资源类型列表。',
'type' => 'array',
'items' => [
'description' => '资源类型列表。'."\n"
."\n"
.'> 配置审计默认返回全部资源类型,返回示例仅以资源类型`ACS::ECS::Instance`和`ACS::ECS::NetworkInterface`为例进行展示。'."\n"
."\n\n"
."\n",
'type' => 'string',
'example' => '["ACS::ECS::Instance","ACS::ECS::NetworkInterface"]',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A3601178-A6A2-4636-BE56-1116F73C0B0C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'ProcessIsRunning',
'errorMessage' => 'The process is running.',
],
[
'errorCode' => 'RDMemberNoPermission',
'errorMessage' => 'You are not authorized to perform the operation. The reasons include: 1. You have not enabled the resource directory service. 2. You are not using the administrator account of resource directory.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
500 => [
[
'errorCode' => 'CreateSLRFail',
'errorMessage' => 'Failed to create SLR.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A3601178-A6A2-4636-BE56-1116F73C0B0C\\",\\n \\"ConfigurationRecorder\\": {\\n \\"OrganizationEnableStatus\\": \\"REGISTRABLE\\",\\n \\"ConfigurationRecorderStatus\\": \\"REGISTRABLE\\",\\n \\"OrganizationMasterId\\": 0,\\n \\"AccountId\\": 0,\\n \\"ResourceTypes\\": [\\n \\"[\\\\\\"ACS::ECS::Instance\\\\\\",\\\\\\"ACS::ECS::NetworkInterface\\\\\\"]\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n A3601178-A6A2-4636-BE56-1116F73C0B0C\\n \\n ACS::ECS::Instance\\n ACS::ECS::NetworkInterface\\n 120886317861****\\n REGISTRABLE\\n \\n","errorExample":""}]',
'title' => '设置资源监控范围',
'description' => '使用普通账号或企业管理账号调用该接口的差异如下:'."\n"
.'- 如果您是普通账号,可以调用该接口为当前账号开启配置审计服务。您可以查看当前账号的资源,并管理当前账号的合规规则。'."\n"
.'- 如果您是资源目录的企业管理账号,在调用该接口时将参数`EnterpriseEdition`设置为`true`,可以为所有成员账号开启配置审计服务,且默认创建一个包含所有成员账号的全局账号组。您可以在账号组中查看所有成员账号的资源,并管理所有成员账号的合规规则。'."\n"
."\n"
.'本文将提供一个示例,使用普通账号开启配置审计服务并监控当前账号的资源。'."\n"
."\n\n"
."\n\n"
."\n\n"
."\n",
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~169575~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeConfigurationRecorder' => [
'summary' => '查询设置的资源监控范围。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfigI0TIO6',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ConfigurationRecorder' => [
'description' => '资源监控信息。'."\n",
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '当前阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '100931896542****',
],
'ConfigurationRecorderStatus' => [
'description' => '资源监控状态。取值:'."\n"
.'- REGISTRABLE:未注册。'."\n"
.'- BUILDING:构建中。'."\n"
.'- REGISTERED:已注册。'."\n"
.'- REBUILDING:重新构建中。',
'type' => 'string',
'example' => 'REGISTERED',
],
'OrganizationEnableStatus' => [
'description' => '企业版配置审计升级状态。取值:'."\n"
."\n"
.'- REGISTRABLE:未升级。'."\n"
.'- BUILDING:升级中。'."\n"
.'- REGISTERED:已升级。',
'type' => 'string',
'example' => 'REGISTRABLE',
],
'OrganizationMasterId' => [
'description' => '企业管理账号ID。'."\n"
."\n"
.'> 仅当企业管理账号调用该接口时,返回该参数。',
'type' => 'integer',
'format' => 'int64',
'example' => '120886317861****',
],
'ResourceTypes' => [
'description' => '资源类型列表。',
'type' => 'array',
'items' => [
'description' => '资源类型列表。',
'type' => 'string',
'example' => '["ACS::ECS::Instance","ACS::ECS::NetworkInterface"]',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'A3601178-A6A2-4636-BE56-1116F73C0B0C',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigurationRecorder\\": {\\n \\"AccountId\\": 0,\\n \\"ConfigurationRecorderStatus\\": \\"REGISTERED\\",\\n \\"OrganizationEnableStatus\\": \\"REGISTRABLE\\",\\n \\"OrganizationMasterId\\": 0,\\n \\"ResourceTypes\\": [\\n \\"[\\\\\\"ACS::ECS::Instance\\\\\\",\\\\\\"ACS::ECS::NetworkInterface\\\\\\"]\\"\\n ]\\n },\\n \\"RequestId\\": \\"A3601178-A6A2-4636-BE56-1116F73C0B0C\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\t\\tA3601178-A6A2-4636-BE56-1116F73C0B0C\\n\\t\\t\\n\\t\\t\\tACS::ECS::Instance\\n\\t\\t\\tACS::ECS::NetworkInterface\\n\\t\\t\\t100931896542****\\n\\t\\t\\tREGISTERED\\n\\t\\t\\n","errorExample":""}]',
'title' => '查询资源监控范围',
'description' => '本文将提供一个示例,查询当前阿里云账号`100931896542****`中资源的监控范围。返回结果显示,资源监控类型为`ACS::ECS::Instance`和`ACS::ECS::NetworkInterface`,资源监控状态为`REGISTERED`(已注册)。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~169575~~)。',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PutConfigurationRecorder' => [
'summary' => '新增或修改监控中的资源类型。',
'methods' => [
'post',
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'readAndWrite',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig56XT35',
],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
'name' => 'ResourceTypes',
'in' => 'formData',
'schema' => [
'description' => '资源类型。多个资源类型之间用半角逗号(,)分隔。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ACS::ECS::Instance,ACS::ECS::Disk',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'ConfigurationRecorder' => [
'description' => '资源监控信息。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '当前阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '123456789',
],
'ConfigurationRecorderStatus' => [
'description' => '资源监控状态。取值:'."\n"
.'- REGISTRABLE:未注册。'."\n"
.'- BUILDING:构建中。'."\n"
.'- REGISTERED:已注册。'."\n"
.'- REBUILDING:重新构建中。',
'type' => 'string',
'example' => 'REGISTERED',
],
'ResourceTypes' => [
'description' => '资源类型列表。',
'type' => 'array',
'items' => [
'description' => '资源类型列表。',
'type' => 'string',
'example' => '["ACS::ECS::Instance","ACS::ECS::NetworkInterface"]',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '7C189ED2-30C1-492E-82B6-0D828B556ED9',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'Invalid.ResourceTypes.Value',
'errorMessage' => 'The specified resourceTypes is invalid.',
],
[
'errorCode' => 'ProcessIsRunning',
'errorMessage' => 'The process is running.',
],
[
'errorCode' => 'RDMemberNoPermission',
'errorMessage' => 'You are not authorized to perform the operation. The reasons include: 1. You have not enabled the resource directory service. 2. You are not using the administrator account of resource directory.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::UpdateConfigurationRecorder',
],
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"ConfigurationRecorder\\": {\\n \\"AccountId\\": 123456789,\\n \\"ConfigurationRecorderStatus\\": \\"REGISTERED\\",\\n \\"ResourceTypes\\": [\\n \\"[\\\\\\"ACS::ECS::Instance\\\\\\",\\\\\\"ACS::ECS::NetworkInterface\\\\\\"]\\"\\n ]\\n },\\n \\"RequestId\\": \\"7C189ED2-30C1-492E-82B6-0D828B556ED9\\"\\n}","errorExample":""},{"type":"xml","example":"\\r\\n\\t\\t7C189ED2-30C1-492E-82B6-0D828B556ED9\\r\\n\\t\\t\\r\\n\\t\\t\\tREBUILDING\\r\\n\\t\\t\\tACS::ECS::Instance\\r\\n\\t\\t\\tACS::ECS::Disk\\r\\n\\t\\t\\t123456789\\r\\n\\t\\t\\r\\n","errorExample":""}]',
'title' => '修改监控中的资源类型',
'description' => '该接口仅对当前请求的阿里云账号有效。关于配置审计支持的资源类型,请参见[支持配置审计的云服务](~~127411~~)。'."\n"
."\n\n"
."\n",
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'DescribeDeliveryChannels' => [
'summary' => '查询设置的投递渠道信息。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfigRIQA8M',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'DeliveryChannelIds',
'in' => 'query',
'schema' => [
'description' => '投递渠道ID。多个投递渠道ID之间用半角逗号(,)分隔。'."\n"
."\n"
.'关于如何获取投递渠道ID,请参见[PutDeliveryChannel](~~174253~~)。',
'type' => 'string',
'required' => false,
'example' => 'cdc-d9106457e0d900b1****',
],
],
],
'responses' => [
200 => [
'headers' => [],
'schema' => [
'description' => '投递渠道信息。',
'type' => 'object',
'properties' => [
'DeliveryChannels' => [
'description' => '投递渠道信息。',
'type' => 'array',
'items' => [
'description' => '投递渠道信息。',
'type' => 'object',
'properties' => [
'ConfigurationItemChangeNotification' => [
'description' => '是否接收资源配置变更历史。当资源配置变更时,配置审计向对象存储OSS、日志服务SLS或轻量消息队列(原 MNS)投递资源配置变更历史。取值:'."\n"
.'- true:接收资源配置变更历史。'."\n"
.'- false:不接收资源配置变更历史。',
'type' => 'boolean',
'example' => 'true',
],
'ConfigurationSnapshot' => [
'description' => '是否接收资源定时快照。每天00:00:00和12:00:00,配置审计定时向对象存储OSS投递资源定时快照。取值:'."\n"
.'- true:接收资源定时快照。'."\n"
.'- false:不接收资源定时快照。',
'type' => 'boolean',
'example' => 'false',
],
'DeliveryChannelAssumeRoleArn' => [
'description' => '投递渠道扮演角色ARN。',
'type' => 'string',
'example' => 'acs:ram::120886317861****:role/aliyunserviceroleforconfig',
],
'DeliveryChannelCondition' => [
'description' => '投递渠道附加规则。当前仅MNS类型的投递渠道支持该参数。'."\n"
."\n"
.'您可以指定MNS订阅事件的最低风险等级和资源类型,具体如下:'."\n"
."\n"
.'- 订阅事件的最低风险等级为:`{"filterType":"RuleRiskLevel","value":"1","multiple":false}`。'."\n"
."\n"
.' value表示您需要过滤的风险等级。取值:1表示高风险,2表示中风险,3表示低风险。'."\n"
."\n"
.'- 订阅事件的资源类型为:`{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`。'."\n"
.' '."\n"
.' values表示您需要订阅事件的资源类型,是一个资源类型的JSON数组。'."\n"
."\n"
.' 例如:`[{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]`'."\n",
'type' => 'string',
'example' => '[{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]',
],
'DeliveryChannelId' => [
'description' => '投递渠道ID。',
'type' => 'string',
'example' => 'cdc-d9106457e0d900b1****',
],
'DeliveryChannelName' => [
'description' => '投递渠道名称。',
'type' => 'string',
'example' => 'myDeliveryChannel',
],
'DeliveryChannelTargetArn' => [
'description' => '投递渠道目标地址的ARN。'."\n"
."\n"
.'- 当DeliveryChannelType为OSS时,该参数为Bucket的ARN。'."\n"
."\n"
.'- 当DeliveryChannelType为MNS时,该参数为Topic的ARN。'."\n"
."\n"
.'- 当DeliveryChannelType为SLS时,该参数为Logstore的ARN。',
'type' => 'string',
'example' => 'acs:oss:cn-shanghai:120886317861****:new-bucket',
],
'DeliveryChannelType' => [
'description' => '投递渠道类型。取值:'."\n"
.'- OSS:对象存储。 '."\n"
.'- MNS:轻量消息队列(原 MNS)。'."\n"
.'- SLS:日志服务。',
'type' => 'string',
'example' => 'OSS',
],
'Description' => [
'description' => '投递渠道描述。',
'type' => 'string',
'example' => 'My OSS delivery.',
],
'NonCompliantNotification' => [
'description' => '是否接收资源不合规事件。当资源不合规时,配置审计向日志服务SLS或轻量消息队列(原 MNS)投递资源不合规事件。取值: '."\n"
.'- true:接收资源不合规事件。'."\n"
.'- false:不接收资源不合规事件。',
'type' => 'boolean',
'example' => 'false',
],
'OversizedDataOSSTargetArn' => [
'description' => '当投递数据超过投递渠道限制时,投递数据转存到对象存储OSS的目标存储空间。'."\n",
'type' => 'string',
'example' => 'acs:oss:cn-shanghai:100931896542****:new-bucket',
],
'Status' => [
'description' => '投递设置状态。取值:'."\n"
.'- 0:关闭。'."\n"
.'- 1:开启。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'DC300244-FCE3-5061-8214-C27ECB668487',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeliveryChannelNotExists',
'errorMessage' => 'The delivery channel does not exist.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::ListConfigDeliveryChannels',
'Config::2020-09-07::ListAggregateConfigDeliveryChannels',
],
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DeliveryChannels\\": [\\n {\\n \\"ConfigurationItemChangeNotification\\": true,\\n \\"ConfigurationSnapshot\\": false,\\n \\"DeliveryChannelAssumeRoleArn\\": \\"acs:ram::120886317861****:role/aliyunserviceroleforconfig\\",\\n \\"DeliveryChannelCondition\\": \\"[{\\\\\\"filterType\\\\\\":\\\\\\"ResourceType\\\\\\",\\\\\\"values\\\\\\":[\\\\\\"ACS::ActionTrail::Trail\\\\\\",\\\\\\"ACS::CBWP::CommonBandwidthPackage\\\\\\",\\\\\\"ACS::CDN::Domain\\\\\\",\\\\\\"ACS::CEN::CenBandwidthPackage\\\\\\",\\\\\\"ACS::CEN::CenInstance\\\\\\",\\\\\\"ACS::CEN::Flowlog\\\\\\",\\\\\\"ACS::DdosCoo::Instance\\\\\\"],\\\\\\"multiple\\\\\\":true}]\\",\\n \\"DeliveryChannelId\\": \\"cdc-d9106457e0d900b1****\\",\\n \\"DeliveryChannelName\\": \\"myDeliveryChannel\\",\\n \\"DeliveryChannelTargetArn\\": \\"acs:oss:cn-shanghai:120886317861****:new-bucket\\",\\n \\"DeliveryChannelType\\": \\"OSS\\",\\n \\"Description\\": \\"My OSS delivery.\\",\\n \\"NonCompliantNotification\\": false,\\n \\"OversizedDataOSSTargetArn\\": \\"acs:oss:cn-shanghai:100931896542****:new-bucket\\",\\n \\"Status\\": 1\\n }\\n ],\\n \\"RequestId\\": \\"DC300244-FCE3-5061-8214-C27ECB668487\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\t\\n\\t\\t1\\n\\t\\tfalse\\n\\t\\t\\n\\t\\tMy OSS delivery.\\n\\t\\tmyDeliveryChannel\\n\\t\\tcdc-d9106457e0d900b1****\\n\\t\\tacs:oss:cn-shanghai:120886317861****:new-bucket\\n\\t\\tacs:ram::120886317861****:role/aliyunserviceroleforconfig\\n\\t\\ttrue\\n\\t\\tOSS\\n\\t\\t\\n\\t\\tfalse\\n\\t\\n\\tDC300244-FCE3-5061-8214-C27ECB668487\\n\\t","errorExample":""}]',
'title' => '查询投递渠道信息',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'PutDeliveryChannel' => [
'summary' => '为当前账号创建或更新投递渠道。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'write',
'deprecated' => true,
'systemTags' => [
'operationType' => 'update',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfigL91U0A',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ClientToken',
'in' => 'formData',
'schema' => [
'description' => '保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符,且不能超过64个字符。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '1594295238-f9361358-5843-4294-8d30-b5183fac****',
],
],
[
'name' => 'DeliveryChannelId',
'in' => 'formData',
'schema' => [
'description' => '投递渠道ID。当您更新指定投递渠道时,必须填写。',
'type' => 'string',
'required' => false,
'example' => 'cdc-193f6457e0d90080****',
],
],
[
'name' => 'DeliveryChannelName',
'in' => 'formData',
'schema' => [
'description' => '投递渠道名称。',
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => 'testoss',
],
],
[
'name' => 'DeliveryChannelType',
'in' => 'formData',
'schema' => [
'description' => '投递渠道类型。当您创建投递渠道时,必须填写。取值:'."\n"
."\n"
.'- OSS:对象存储'."\n"
."\n"
.'- MNS:轻量消息队列(原 MNS)'."\n"
."\n"
.'- SLS:日志服务',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'OSS',
'enum' => [
'OSS',
'MNS',
'SLS',
],
],
],
[
'name' => 'DeliveryChannelTargetArn',
'in' => 'formData',
'schema' => [
'description' => '投递渠道目标地址的ARN。当您创建投递渠道时,必须填写。取值:'."\n"
."\n"
.'- 当投递渠道为OSS时,格式为:`acs:oss:{RegionId}:{Aliuid}:{bucketName}`。'."\n"
."\n"
.'- 当投递渠道为MNS时,格式为:`acs:mns:{RegionId}:{Aliuid}:/topics/{topicName}`。'."\n"
."\n"
.'- 当投递渠道为SLS时,格式为:`acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName}`'."\n",
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'acs:oss:cn-hangzhou:100931896542****:20171130--1',
],
],
[
'name' => 'DeliveryChannelAssumeRoleArn',
'in' => 'formData',
'schema' => [
'description' => '投递角色ARN。当您创建投递渠道时,必须填写。'."\n"
."\n"
.'> 如果您使用配置审计服务角色,则可按照示例值填写,将其中的账号ID替换为您的真实账号ID。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'acs:ram::100931896542****:role/aliyunserviceroleforconfig',
],
],
[
'name' => 'DeliveryChannelCondition',
'in' => 'formData',
'schema' => [
'description' => '投递渠道附加规则。当前仅支持MNS类型的投递渠道。'."\n"
."\n"
.'您可以指定MNS订阅事件的最低风险等级和资源类型,具体如下:'."\n"
."\n"
.'- 订阅事件的最低风险等级为:`{"filterType":"RuleRiskLevel","value":"1","multiple":false}`。'."\n"
."\n"
.' value表示您需要过滤的风险等级。取值:1表示高风险,2表示中风险,3表示低风险。'."\n"
."\n"
.'- 订阅事件的资源类型为:`{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}`。'."\n"
.' '."\n"
.' values表示您需要订阅事件的资源类型,是一个资源类型的JSON数组。'."\n"
.' 例如:'."\n"
.'`[{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]`'."\n"
."\n",
'type' => 'string',
'required' => false,
'docRequired' => false,
'example' => '[{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]',
],
],
[
'name' => 'Description',
'in' => 'formData',
'schema' => [
'description' => '投递渠道描述。',
'type' => 'string',
'required' => false,
'example' => 'My OSS delivery.',
],
],
[
'name' => 'Status',
'in' => 'formData',
'schema' => [
'description' => '投递渠道状态。取值:'."\n"
."\n"
.'- 0:停用'."\n"
."\n"
.'- 1(默认值):启用',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DeliveryChannelId' => [
'description' => '创建或更新投递渠道成功后,返回的投递渠道ID。',
'type' => 'string',
'example' => 'cdc-ee0f626622af0069****',
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => '0D6B9E0A-AD53-4732-922B-0F584ECA5FAB',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'DeliveryChannelNotExists',
'errorMessage' => 'The delivery channel does not exist.',
],
[
'errorCode' => 'Invalid.DeliveryChannelName.Empty',
'errorMessage' => 'You must specify DeliveryChannelName.',
],
[
'errorCode' => 'Invalid.DeliveryChannelType.Empty',
'errorMessage' => 'You must specify DeliveryChannelType.',
],
[
'errorCode' => 'Invalid.DeliveryChannelAssumeRoleArn.Empty',
'errorMessage' => 'You must specify DeliveryChannelAssumeRoleArn.',
],
[
'errorCode' => 'Invalid.DeliveryChannelAssumeRoleArn.Format',
'errorMessage' => 'The specified format of DeliveryChannelAssumeRoleArn is invalid.',
],
[
'errorCode' => 'Invalid.DeliveryChannelTargetArn.Empty',
'errorMessage' => 'You must specify DeliveryChannelTargetArn.',
],
[
'errorCode' => 'Invalid.DeliveryChannelTargetArn.Format',
'errorMessage' => 'The specified format of DeliveryChannelTargetArn is invalid.',
],
[
'errorCode' => 'Invalid.DeliveryChannelCondition.Format',
'errorMessage' => 'The specified format of DeliveryChannelCondition is invalid.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
[
'errorCode' => 'DeliveryChannelAccountNotSupport',
'errorMessage' => 'Cross-account delivery that is not in the RD is not supported.',
],
[
'errorCode' => 'DeliveryChannelMnsUnreachable',
'errorMessage' => 'The MNS topic is unreachable.',
],
[
'errorCode' => 'DeliveryChannelOssUnreachable',
'errorMessage' => 'The OSS bucket is unreachable.',
],
[
'errorCode' => 'DeliveryChannelSlsUnreachable',
'errorMessage' => 'SLS logstore is unreachable.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::CreateConfigDeliveryChannel',
'Config::2020-09-07::CreateAggregateConfigDeliveryChannel',
],
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DeliveryChannelId\\": \\"cdc-ee0f626622af0069****\\",\\n \\"RequestId\\": \\"0D6B9E0A-AD53-4732-922B-0F584ECA5FAB\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0D6B9E0A-AD53-4732-922B-0F584ECA5FAB\\n cdc-ee0f626622af0069****\\n","errorExample":""}]',
'title' => '创建或更新投递渠道',
'description' => '****',
'requestParamsDescription' => ' ',
'responseParamsDescription' => ' ',
'extraInfo' => ' ',
],
'GetAggregateDiscoveredResource' => [
'summary' => '查询指定账号组内指定资源详情。',
'methods' => [
'get',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。'."\n"
."\n"
.'关于如何获取资源ID,请参见[ListAggregateDiscoveredResources](~~265983~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'new-bucket',
],
],
[
'name' => 'ResourceType',
'in' => 'query',
'schema' => [
'description' => '资源类型。'."\n"
."\n"
.'关于如何获取资源类型,请参见[ListAggregateDiscoveredResources](~~265983~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ACS::OSS::Bucket',
],
],
[
'name' => 'Region',
'in' => 'query',
'schema' => [
'description' => '资源所在地域ID。'."\n"
."\n"
.'关于如何获取资源所在地域ID,请参见[ListAggregateDiscoveredResources](~~265983~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'cn-hangzhou',
],
],
[
'name' => 'AggregatorId',
'in' => 'query',
'schema' => [
'description' => '账号组ID。'."\n"
."\n"
.'关于如何获取账号组ID,请参见[ListAggregators](~~255797~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ca-5885626622af0008****',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'DiscoveredResourceDetail' => [
'description' => '资源详情。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '资源拥有者的阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '100931896542****',
],
'AvailabilityZone' => [
'description' => '资源可用区。',
'type' => 'string',
'example' => 'cn-hangzhou-h',
],
'Configuration' => [
'description' => '资源的完整配置信息。',
'type' => 'string',
'example' => '{\\"AccessControlList\\":{\\"Grant\\":\\"private\\"},\\"ServerSideEncryptionRule\\":{\\"SSEAlgorithm\\":\\"None\\"},\\"Comment\\":\\"\\",\\"CreationDate\\":\\"2021-06-29T10:05:12.000Z\\",\\"Owner\\":{\\"DisplayName\\":\\"100931896542****\\",\\"ID\\":\\"100931896542****\\"},\\"StorageClass\\":\\"Standard\\",\\"DataRedundancyType\\":\\"LRS\\",\\"AllowEmptyReferer\\":\\"true\\",\\"Name\\":\\"new-bucket\\",\\"BucketPolicy\\":{\\"LogPrefix\\":\\"\\",\\"LogBucket\\":\\"\\"},\\"ExtranetEndpoint\\":\\"oss-cn-hangzhou.aliyuncs.com\\",\\"IntranetEndpoint\\":\\"oss-cn-hangzhou-internal.aliyuncs.com\\",\\"Location\\":\\"oss-cn-hangzhou\\"}',
],
'Region' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-hangzhou',
],
'ResourceCreationTime' => [
'description' => '资源创建时间戳。',
'type' => 'integer',
'format' => 'int64',
'example' => '1624961112000',
],
'ResourceDeleted' => [
'description' => '资源删除状态。取值:'."\n"
.'- 1:未删除。'."\n"
.'- 0:已删除。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'new-bucket',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'new-bucket',
],
'ResourceStatus' => [
'description' => '资源状态。资源的状态取决于各云服务对其的定义,该参数可能为空。例如:'."\n"
."\n"
.'- 当资源类型为ACS::ECS::Instance时,由于ECS实例有状态,因此该参数为Running或Stopped。'."\n"
."\n"
.'- 当资源类型为ACS::OSS::Bucket时,由于OSS Bucket无状态,因此该参数为空。',
'type' => 'string',
'example' => 'offline',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ACS::OSS::BucketACS::CDN::Domain',
],
'Tags' => [
'description' => '资源标签。',
'type' => 'string',
'example' => '{\\"\\"hc\\"\\":[\\"\\"value2\\"\\"]}',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'E4D71ACE-6B0A-46E0-8352-56952378CC7F',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::GetAggregateDiscoveredResource',
],
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DiscoveredResourceDetail\\": {\\n \\"AccountId\\": 0,\\n \\"AvailabilityZone\\": \\"cn-hangzhou-h\\",\\n \\"Configuration\\": \\"{\\\\\\\\\\\\\\"AccessControlList\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Grant\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"private\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"ServerSideEncryptionRule\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"SSEAlgorithm\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"None\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"Comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"CreationDate\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"2021-06-29T10:05:12.000Z\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Owner\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"DisplayName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"100931896542****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ID\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"100931896542****\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"StorageClass\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Standard\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"DataRedundancyType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"LRS\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"AllowEmptyReferer\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"new-bucket\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"BucketPolicy\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"LogPrefix\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"LogBucket\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"ExtranetEndpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"IntranetEndpoint\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou-internal.aliyuncs.com\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Location\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss-cn-hangzhou\\\\\\\\\\\\\\"}\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"ResourceCreationTime\\": 1624961112000,\\n \\"ResourceDeleted\\": 1,\\n \\"ResourceId\\": \\"new-bucket\\",\\n \\"ResourceName\\": \\"new-bucket\\",\\n \\"ResourceStatus\\": \\"offline\\",\\n \\"ResourceType\\": \\"ACS::OSS::BucketACS::CDN::Domain\\",\\n \\"Tags\\": \\"{\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"hc\\\\\\\\\\\\\\"\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"]}\\"\\n },\\n \\"RequestId\\": \\"E4D71ACE-6B0A-46E0-8352-56952378CC7F\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\tE4D71ACE-6B0A-46E0-8352-56952378CC7F\\n\\t\\n\\t\\t100931896542****\\n\\t\\t1624961112000\\n\\t\\t{\\\\\\"AccessControlList\\\\\\":{\\\\\\"Grant\\\\\\":\\\\\\"private\\\\\\"},\\\\\\"ServerSideEncryptionRule\\\\\\":{\\\\\\"SSEAlgorithm\\\\\\":\\\\\\"None\\\\\\"},\\\\\\"Comment\\\\\\":\\\\\\"\\\\\\",\\\\\\"CreationDate\\\\\\":\\\\\\"2021-06-29T10:05:12.000Z\\\\\\",\\\\\\"Owner\\\\\\":{\\\\\\"DisplayName\\\\\\":\\\\\\"100931896542****\\\\\\",\\\\\\"ID\\\\\\":\\\\\\"100931896542****\\\\\\"},\\\\\\"StorageClass\\\\\\":\\\\\\"Standard\\\\\\",\\\\\\"DataRedundancyType\\\\\\":\\\\\\"LRS\\\\\\",\\\\\\"AllowEmptyReferer\\\\\\":\\\\\\"true\\\\\\",\\\\\\"Name\\\\\\":\\\\\\"new-bucket\\\\\\",\\\\\\"BucketPolicy\\\\\\":{\\\\\\"LogPrefix\\\\\\":\\\\\\"\\\\\\",\\\\\\"LogBucket\\\\\\":\\\\\\"\\\\\\"},\\\\\\"ExtranetEndpoint\\\\\\":\\\\\\"oss-cn-hangzhou.aliyuncs.com\\\\\\",\\\\\\"IntranetEndpoint\\\\\\":\\\\\\"oss-cn-hangzhou-internal.aliyuncs.com\\\\\\",\\\\\\"Location\\\\\\":\\\\\\"oss-cn-hangzhou\\\\\\"}\\n\\t\\tnew-bucket\\n\\t\\tnew-bucket\\n\\t\\tcn-hangzhou\\n\\t\\tcn-hangzhou-h\\n\\t\\t\\n\\t\\tACS::OSS::Bucket\\n\\t\\t1\\n\\t\\t{\\\\\\"\\\\\\"hc\\\\\\"\\\\\\":[\\\\\\"\\\\\\"value2\\\\\\"\\\\\\"]}\\n\\t\\n\\t","errorExample":""}]',
'title' => '查询资源详情',
'description' => '本文将提供一个示例,查询账号组`ca-5885626622af0008****`内资源`new-bucket`的详情。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~169575~~)。',
],
'ListAggregateDiscoveredResources' => [
'summary' => '查询指定账号组内的资源列表。',
'methods' => [
'get',
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => true,
'systemTags' => [
'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'free',
'abilityTreeNodes' => [
'FEATUREconfig6XGW41',
],
'autoTest' => true,
'tenantRelevance' => 'tenant',
],
'parameters' => [
[
'name' => 'ResourceId',
'in' => 'query',
'schema' => [
'description' => '资源ID。',
'type' => 'string',
'required' => false,
'example' => 'eni-hp31cqoba96jagtz****',
],
],
[
'name' => 'ResourceDeleted',
'in' => 'query',
'schema' => [
'description' => '资源状态。取值:'."\n"
."\n"
.'- 0:已删除。'."\n"
.'- 1(默认值):保有中。',
'type' => 'integer',
'format' => 'int32',
'required' => false,
'example' => '1',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页时每页显示的数据行数。'."\n"
."\n"
.'取值范围:1~100。起始值:1。默认值:10。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100',
'minimum' => '1',
'example' => '10',
],
],
[
'name' => 'PageNumber',
'in' => 'query',
'schema' => [
'description' => '页码。'."\n"
."\n"
.'起始值:1。默认值:1。',
'type' => 'integer',
'format' => 'int32',
'required' => true,
'docRequired' => true,
'maximum' => '100000',
'minimum' => '1',
'example' => '1',
],
],
[
'name' => 'ResourceTypes',
'in' => 'query',
'schema' => [
'description' => '资源类型。多个资源类型之间用半角逗号(,)分隔。',
'type' => 'string',
'required' => false,
'example' => 'ACS::ECS::NetworkInterface',
],
],
[
'name' => 'Regions',
'in' => 'query',
'schema' => [
'description' => '资源归属的地域ID。多个地域ID之间用半角逗号(,)分隔。'."\n"
."\n"
.'关于如何获取资源所在地域ID,请参见[ListAggregateDiscoveredResources](~~265983~~)。',
'type' => 'string',
'required' => false,
'example' => 'cn-huhehaote',
],
],
[
'name' => 'AggregatorId',
'in' => 'query',
'schema' => [
'description' => '账号组ID。'."\n"
."\n"
.'关于如何获取账号组ID,请参见[ListAggregators](~~255797~~)。',
'type' => 'string',
'required' => true,
'docRequired' => true,
'example' => 'ca-c560626622af0005****',
],
],
],
'responses' => [
200 => [
'schema' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'DiscoveredResourceProfiles' => [
'description' => '资源列表。',
'type' => 'object',
'properties' => [
'DiscoveredResourceProfileList' => [
'description' => '资源列表详情。',
'type' => 'array',
'items' => [
'description' => '无。',
'type' => 'object',
'properties' => [
'AccountId' => [
'description' => '资源拥有者的阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '161259599160****',
],
'Region' => [
'description' => '地域ID。',
'type' => 'string',
'example' => 'cn-huhehaote',
],
'ResourceCreationTime' => [
'description' => '资源创建时间戳。单位:毫秒。',
'type' => 'integer',
'format' => 'int64',
'example' => '1618675206000',
],
'ResourceDeleted' => [
'description' => '资源状态。取值:'."\n"
.'- 0:已删除。'."\n"
.'- 1:保有中。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'ResourceId' => [
'description' => '资源ID。',
'type' => 'string',
'example' => 'eni-hp31cqoba96jagtz****',
],
'ResourceName' => [
'description' => '资源名称。',
'type' => 'string',
'example' => 'Cloud Firewall',
],
'ResourceOwnerId' => [
'description' => '资源拥有者的阿里云账号ID。',
'type' => 'integer',
'format' => 'int64',
'example' => '161259599160****',
],
'ResourceStatus' => [
'description' => '资源状态。资源的状态取决于各云服务对其的定义,该参数可能为空。例如:'."\n"
.'- 当资源类型为ACS::ECS::Instance时,由于ECS实例有状态,因此该参数为Running或Stopped。'."\n"
.'- 当资源类型为ACS::OSS::Bucket时,由于OSS Bucket无状态,因此该参数为空。',
'type' => 'string',
'example' => 'InUse',
],
'ResourceType' => [
'description' => '资源类型。',
'type' => 'string',
'example' => 'ACS::ECS::NetworkInterface',
],
'Tags' => [
'description' => '资源标签。',
'type' => 'string',
'example' => '{\\"key1\\":[\\"value2\\"]}',
],
],
],
],
'PageNumber' => [
'description' => '资源列表的页码。起始值:1。',
'type' => 'integer',
'format' => 'int32',
'example' => '1',
],
'PageSize' => [
'description' => '分页查询时设置的每页行数。取值范围:1~100。',
'type' => 'integer',
'format' => 'int32',
'example' => '10',
],
'TotalCount' => [
'description' => '资源总数。',
'type' => 'integer',
'format' => 'int32',
'example' => '8',
],
],
],
'RequestId' => [
'description' => '请求ID。',
'type' => 'string',
'example' => 'C7817373-78CB-4F9A-8AFA-E7A88E9D64A2',
],
],
],
],
],
'errorCodes' => [
400 => [
[
'errorCode' => 'NoPermission',
'errorMessage' => 'You are not authorized to perform this operation.',
],
[
'errorCode' => 'MemberNotBelongToMaster',
'errorMessage' => 'The specified member does not belong to your organization.',
],
],
404 => [
[
'errorCode' => 'AccountNotExisted',
'errorMessage' => 'Your account does not exist.',
],
],
503 => [
[
'errorCode' => 'ServiceUnavailable',
'errorMessage' => 'The request has failed due to a temporary failure of the server.',
],
],
],
'staticInfo' => [
'substitutions' => [
'Config::2020-09-07::ListAggregateDiscoveredResources',
],
'returnType' => 'synchronous',
],
'responseDemo' => '[{"type":"json","example":"{\\n \\"DiscoveredResourceProfiles\\": {\\n \\"DiscoveredResourceProfileList\\": [\\n {\\n \\"AccountId\\": 0,\\n \\"Region\\": \\"cn-huhehaote\\",\\n \\"ResourceCreationTime\\": 1618675206000,\\n \\"ResourceDeleted\\": 1,\\n \\"ResourceId\\": \\"eni-hp31cqoba96jagtz****\\",\\n \\"ResourceName\\": \\"Cloud Firewall\\",\\n \\"ResourceOwnerId\\": 0,\\n \\"ResourceStatus\\": \\"InUse\\",\\n \\"ResourceType\\": \\"ACS::ECS::NetworkInterface\\",\\n \\"Tags\\": \\"{\\\\\\\\\\\\\\"key1\\\\\\\\\\\\\\":[\\\\\\\\\\\\\\"value2\\\\\\\\\\\\\\"]}\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 8\\n },\\n \\"RequestId\\": \\"C7817373-78CB-4F9A-8AFA-E7A88E9D64A2\\"\\n}","errorExample":""},{"type":"xml","example":"\\n\\t\\n\\t\\t\\n\\t\\t\\tACS::ECS::NetworkInterface\\n\\t\\t\\tcn-huhehaote\\n\\t\\t\\t1618675206000\\n\\t\\t\\t{\\\\\\"key1\\\\\\":[\\\\\\"value2\\\\\\"]}\\n\\t\\t\\teni-hp31cqoba96jagtz****\\n\\t\\t\\tCloud Firewall\\n\\t\\t\\t1\\n\\t\\t\\tInUse\\n\\t\\t\\n\\t\\t1\\n\\t\\t10\\n\\t\\t8\\n\\t\\n\\tC7817373-78CB-4F9A-8AFA-E7A88E9D64A2\\n\\t","errorExample":""}]',
'title' => '查询账号组资源列表',
'description' => '本文将提供一个示例,查询账号组`ca-c560626622af0005****`内的资源列表。返回结果显示资源列表中的所有资源,共8个。',
'requestParamsDescription' => '关于公共请求参数的详情,请参见[公共参数](~~169575~~)。',
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'config.cn-shanghai.aliyuncs.com',
],
[
'regionId' => 'ap-southeast-1',
'endpoint' => 'config.ap-southeast-1.aliyuncs.com',
],
],
];