GetDiscoveredResource - 获取指定资源的资源详情

获取指定资源的资源详情。

接口说明

本文将提供一个示例,查询杭州地域的 ECS 实例i-bp12g4xbl4i0brkn****的详情。

调试

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

授权信息

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

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

请求参数

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

资源 ID。

关于如何获取资源 ID,请参见 ListDiscoveredResources

i-bp12g4xbl4i0brkn****
ResourceTypestring

资源类型。

关于如何获取资源类型,请参见 ListDiscoveredResources

ACS::ECS::Instance
Regionstring

资源所在地域 ID。

关于如何获取资源所在地域 ID,请参见 ListDiscoveredResources

cn-hangzhou
ComplianceOptioninteger

查询资源合规结果。取值:

  • 0(默认值):不查询。

  • 1:查询。

0

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

无。

RequestIdstring

请求 ID。

E4D71ACE-6B0A-46E0-8352-56952378CC7F
DiscoveredResourceDetailobject

资源详情。

AvailabilityZonestring

资源可用区。

cn-hangzhou-h
ResourceTypestring

资源类型。

ACS::ECS::Instance
Configurationstring

资源的完整配置信息。

{\"ResourceGroupId\":\"\",\"Memory\":4096,\"InstanceChargeType\":\"PostPaid\",\"Cpu\":2,\"OSName\":\"Windows Server 2022 数据中心版 64位中文版\",\"InstanceNetworkType\":\"vpc\",\"InnerIpAddress\":{\"IpAddress\":[]},\"ExpiredTime\":\"2099-12-31T15:59Z\",\"ImageId\":\"win2022_21H2_x64_dtc_zh-cn_40G_alibase_20240110.vhd\",\"EipAddress\":{\"AllocationId\":\"\",\"IpAddress\":\"\",\"InternetChargeType\":\"\"},\"ImageOptions\":{},\"VlanId\":\"\",\"HostName\":\"iZl4i0brknq****\",\"Status\":\"Stopped\",\"HibernationOptions\":{\"Configured\":false},\"MetadataOptions\":{\"HttpTokens\":\"\",\"HttpEndpoint\":\"\"},\"InstanceId\":\"i-bp12g4xbl4i0brkn****\",\"StoppedMode\":\"KeepCharging\",\"CpuOptions\":{\"ThreadsPerCore\":2,\"Numa\":\"ON\",\"CoreCount\":1},\"StartTime\":\"2024-02-29T07:08Z\",\"DeletionProtection\":false,\"VpcAttributes\":{\"PrivateIpAddress\":{\"IpAddress\":[\"172.16.XX.XX\"]},\"VpcId\":\"vpc-bp1wjaw8t272wwmkg****\",\"VSwitchId\":\"vsw-bp103i8xzww5132ul****\",\"NatIpAddress\":\"\"},\"SecurityGroupIds\":{\"SecurityGroupId\":[\"sg-bp1h96fz9fagaegp****\"]},\"InternetChargeType\":\"PayByTraffic\",\"InstanceName\":\"test123\",\"DeploymentSetId\":\"\",\"InternetMaxBandwidthOut\":5,\"SerialNumber\":\"6764f567-28fb-4a39-bfc3-48404995****\",\"OSType\":\"windows\",\"CreationTime\":\"2024-02-29T07:08Z\",\"AutoReleaseTime\":\"\",\"Description\":\"\",\"InstanceTypeFamily\":\"ecs.c7\",\"DedicatedInstanceAttribute\":{\"Tenancy\":\"\",\"Affinity\":\"\"},\"PublicIpAddress\":{\"IpAddress\":[\"47.98.XX.XX\"]},\"GPUSpec\":\"\",\"NetworkInterfaces\":{\"NetworkInterface\":[{\"Type\":\"Primary\",\"PrimaryIpAddress\":\"172.16.XX.XX\",\"MacAddress\":\"00:16:3e:0c:**:**\",\"NetworkInterfaceId\":\"eni-bp19uj35v8won3x9****\",\"PrivateIpSets\":{\"PrivateIpSet\":[{\"PrivateIpAddress\":\"172.16.XX.XX\",\"Primary\":true}]}}]},\"SpotPriceLimit\":0.0,\"SaleCycle\":\"\",\"DeviceAvailable\":true,\"InstanceType\":\"ecs.c7.large\",\"OSNameEn\":\"Windows Server 2022 DataCenter Edition 64bit Chinese Edition\",\"SpotStrategy\":\"NoSpot\",\"IoOptimized\":true,\"ZoneId\":\"cn-hangzhou-b\",\"ClusterId\":\"\",\"EcsCapacityReservationAttr\":{\"CapacityReservationPreference\":\"\",\"CapacityReservationId\":\"\"},\"DedicatedHostAttribute\":{\"DedicatedHostId\":\"\",\"DedicatedHostName\":\"\",\"DedicatedHostClusterId\":\"\"},\"GPUAmount\":0,\"OperationLocks\":{\"LockReason\":[]},\"InternetMaxBandwidthIn\":2000,\"Recyclable\":false,\"RegionId\":\"cn-hangzhou\",\"CreditSpecification\":\"\"}
Regionstring

地域 ID。

cn-hangzhou
ResourceCreationTimelong

资源创建时间戳。

1709190480000
Tagsstring

资源标签。

{\"\"hc\"\":[\"\"value2\"\"]}
AccountIdlong

资源拥有者的阿里云账号 ID。

120886317861****
ResourceIdstring

资源 ID。

i-bp12g4xbl4i0brkn****
ResourceDeletedinteger

资源删除状态。取值:

  • 1:未删除。
  • 0:已删除。
1
ResourceNamestring

资源名称。

test123
ResourceStatusstring

资源状态。资源的状态取决于各云服务对其的定义,该参数可能为空。例如:

  • 当资源类型为 ACS::ECS::Instance 时,由于 ECS 实例有状态,因此该参数为 Running 或 Stopped。

  • 当资源类型为 ACS::OSS::Bucket 时,由于 OSS Bucket 无状态,因此该参数为空。

Stopped
ComplianceTypestring

合规类型

COMPLIANT

示例

正常返回示例

JSON格式

{
  "RequestId": "E4D71ACE-6B0A-46E0-8352-56952378CC7F",
  "DiscoveredResourceDetail": {
    "AvailabilityZone": "cn-hangzhou-h",
    "ResourceType": "ACS::ECS::Instance",
    "Configuration": "{\\\"ResourceGroupId\\\":\\\"\\\",\\\"Memory\\\":4096,\\\"InstanceChargeType\\\":\\\"PostPaid\\\",\\\"Cpu\\\":2,\\\"OSName\\\":\\\"Windows Server  2022 数据中心版 64位中文版\\\",\\\"InstanceNetworkType\\\":\\\"vpc\\\",\\\"InnerIpAddress\\\":{\\\"IpAddress\\\":[]},\\\"ExpiredTime\\\":\\\"2099-12-31T15:59Z\\\",\\\"ImageId\\\":\\\"win2022_21H2_x64_dtc_zh-cn_40G_alibase_20240110.vhd\\\",\\\"EipAddress\\\":{\\\"AllocationId\\\":\\\"\\\",\\\"IpAddress\\\":\\\"\\\",\\\"InternetChargeType\\\":\\\"\\\"},\\\"ImageOptions\\\":{},\\\"VlanId\\\":\\\"\\\",\\\"HostName\\\":\\\"iZl4i0brknq****\\\",\\\"Status\\\":\\\"Stopped\\\",\\\"HibernationOptions\\\":{\\\"Configured\\\":false},\\\"MetadataOptions\\\":{\\\"HttpTokens\\\":\\\"\\\",\\\"HttpEndpoint\\\":\\\"\\\"},\\\"InstanceId\\\":\\\"i-bp12g4xbl4i0brkn****\\\",\\\"StoppedMode\\\":\\\"KeepCharging\\\",\\\"CpuOptions\\\":{\\\"ThreadsPerCore\\\":2,\\\"Numa\\\":\\\"ON\\\",\\\"CoreCount\\\":1},\\\"StartTime\\\":\\\"2024-02-29T07:08Z\\\",\\\"DeletionProtection\\\":false,\\\"VpcAttributes\\\":{\\\"PrivateIpAddress\\\":{\\\"IpAddress\\\":[\\\"172.16.XX.XX\\\"]},\\\"VpcId\\\":\\\"vpc-bp1wjaw8t272wwmkg****\\\",\\\"VSwitchId\\\":\\\"vsw-bp103i8xzww5132ul****\\\",\\\"NatIpAddress\\\":\\\"\\\"},\\\"SecurityGroupIds\\\":{\\\"SecurityGroupId\\\":[\\\"sg-bp1h96fz9fagaegp****\\\"]},\\\"InternetChargeType\\\":\\\"PayByTraffic\\\",\\\"InstanceName\\\":\\\"test123\\\",\\\"DeploymentSetId\\\":\\\"\\\",\\\"InternetMaxBandwidthOut\\\":5,\\\"SerialNumber\\\":\\\"6764f567-28fb-4a39-bfc3-48404995****\\\",\\\"OSType\\\":\\\"windows\\\",\\\"CreationTime\\\":\\\"2024-02-29T07:08Z\\\",\\\"AutoReleaseTime\\\":\\\"\\\",\\\"Description\\\":\\\"\\\",\\\"InstanceTypeFamily\\\":\\\"ecs.c7\\\",\\\"DedicatedInstanceAttribute\\\":{\\\"Tenancy\\\":\\\"\\\",\\\"Affinity\\\":\\\"\\\"},\\\"PublicIpAddress\\\":{\\\"IpAddress\\\":[\\\"47.98.XX.XX\\\"]},\\\"GPUSpec\\\":\\\"\\\",\\\"NetworkInterfaces\\\":{\\\"NetworkInterface\\\":[{\\\"Type\\\":\\\"Primary\\\",\\\"PrimaryIpAddress\\\":\\\"172.16.XX.XX\\\",\\\"MacAddress\\\":\\\"00:16:3e:0c:**:**\\\",\\\"NetworkInterfaceId\\\":\\\"eni-bp19uj35v8won3x9****\\\",\\\"PrivateIpSets\\\":{\\\"PrivateIpSet\\\":[{\\\"PrivateIpAddress\\\":\\\"172.16.XX.XX\\\",\\\"Primary\\\":true}]}}]},\\\"SpotPriceLimit\\\":0.0,\\\"SaleCycle\\\":\\\"\\\",\\\"DeviceAvailable\\\":true,\\\"InstanceType\\\":\\\"ecs.c7.large\\\",\\\"OSNameEn\\\":\\\"Windows Server  2022 DataCenter Edition 64bit Chinese Edition\\\",\\\"SpotStrategy\\\":\\\"NoSpot\\\",\\\"IoOptimized\\\":true,\\\"ZoneId\\\":\\\"cn-hangzhou-b\\\",\\\"ClusterId\\\":\\\"\\\",\\\"EcsCapacityReservationAttr\\\":{\\\"CapacityReservationPreference\\\":\\\"\\\",\\\"CapacityReservationId\\\":\\\"\\\"},\\\"DedicatedHostAttribute\\\":{\\\"DedicatedHostId\\\":\\\"\\\",\\\"DedicatedHostName\\\":\\\"\\\",\\\"DedicatedHostClusterId\\\":\\\"\\\"},\\\"GPUAmount\\\":0,\\\"OperationLocks\\\":{\\\"LockReason\\\":[]},\\\"InternetMaxBandwidthIn\\\":2000,\\\"Recyclable\\\":false,\\\"RegionId\\\":\\\"cn-hangzhou\\\",\\\"CreditSpecification\\\":\\\"\\\"}",
    "Region": "cn-hangzhou",
    "ResourceCreationTime": 1709190480000,
    "Tags": "{\\\"\\\"hc\\\"\\\":[\\\"\\\"value2\\\"\\\"]}",
    "AccountId": 0,
    "ResourceId": "i-bp12g4xbl4i0brkn****",
    "ResourceDeleted": 1,
    "ResourceName": "test123",
    "ResourceStatus": "Stopped",
    "ComplianceType": "COMPLIANT"
  }
}

错误码

HTTP status code错误码错误信息描述
400NoPermissionYou are not authorized to perform this operation.您无权执行此操作。
400MemberNotBelongToMasterThe specified member does not belong to your organization.-
404AccountNotExistedYour account does not exist.-
503ServiceUnavailableThe request has failed due to a temporary failure of the server.服务不可用。

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