GetResourceConfigurationSample - 获取资源配置样例

本接口用于获取指定资源类型的配置样例。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

config:GetResourceConfigurationSample

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

ResourceType

string

资源类型。

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

ACS::ECS::Instance

MockOnly

string

是否仅获取模拟数据,即非真实资源数据。 取值:

  • true

  • false

false

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

DC300244-FCE3-5061-8214-C27ECB66****

Sample

object

样例。

ResourceType

string

资源类型。

ACS::ECS::Instance

Configuration

string

资源的完整配置信息。

{\"Status\":\"Running\",\"HibernationOptions\":{\"Configured\":\"false\"},\"ResourceGroupId\":\"rg-bp67acfmxazb4p****\",\"MetadataOptions\":{\"HttpPutResponseHopLimit\":\"0\",\"HttpTokens\":\"optional\",\"HttpEndpoint\":\"enabled\"},\"InstanceId\":\"i-bp67acfmxazb4p****\",\"InstanceChargeType\":\"PostPaid\",\"Memory\":\"16384\",\"StoppedMode\":\"KeepCharging\",\"CpuOptions\":{\"ThreadsPerCore\":\"4\",\"Numa\":\"2\",\"CoreCount\":\"2\"},\"StartTime\":\"2017-12-10T04:04Z\",\"Cpu\":\"8\",\"OSName\":\"CentOS 7.4 64 bit\",\"DeletionProtection\":\"false\",\"SecurityGroupIds\":{\"SecurityGroupId\":[null]},\"InstanceNetworkType\":\"vpc\",\"InnerIpAddress\":{\"IpAddress\":[\"42.112.**.**\"]},\"ExpiredTime\":\"2017-12-10T04:04Z\",\"EipAddress\":{\"AllocationId\":\"eip-2ze88m67qx5z****\",\"Bandwidth\":\"5\",\"IpAddress\":\"42.112.**.**\",\"IsSupportUnassociate\":\"true\",\"InternetChargeType\":\"PayByTraffic\"},\"ImageId\":\"m-bp67acfmxazb4p****\",\"ImageOptions\":{\"LoginAsNonRoot\":\"false\"},\"HostName\":\"testHostName\",\"Tags\":{\"Tag\":[null]},\"VlanId\":\"10\"}

ResourceId

string

资源 ID。

i-bp1aaegapahkh880****

ResourceName

string

资源名称。

my-ecs

ResourceStatus

string

资源状态。

Running

ResourceDeleted

string

资源状态。取值:

  • 1:保有中。

  • 0:已删除。

1

ResourceCreationTime

string

资源创建时间。

1646362560000

Region

string

地域 ID。

cn-shanghai

Version

string

版本信息。

5

AvailabilityZone

string

可用区。

cn-shanghai-g

AccountId

string

用户 ID。

101339776561****

Tags

string

标签。

{\"key\":\"value\"}

示例

正常返回示例

JSON格式

{
  "RequestId": "DC300244-FCE3-5061-8214-C27ECB66****",
  "Sample": {
    "ResourceType": "ACS::ECS::Instance",
    "Configuration": "{\\\"Status\\\":\\\"Running\\\",\\\"HibernationOptions\\\":{\\\"Configured\\\":\\\"false\\\"},\\\"ResourceGroupId\\\":\\\"rg-bp67acfmxazb4p****\\\",\\\"MetadataOptions\\\":{\\\"HttpPutResponseHopLimit\\\":\\\"0\\\",\\\"HttpTokens\\\":\\\"optional\\\",\\\"HttpEndpoint\\\":\\\"enabled\\\"},\\\"InstanceId\\\":\\\"i-bp67acfmxazb4p****\\\",\\\"InstanceChargeType\\\":\\\"PostPaid\\\",\\\"Memory\\\":\\\"16384\\\",\\\"StoppedMode\\\":\\\"KeepCharging\\\",\\\"CpuOptions\\\":{\\\"ThreadsPerCore\\\":\\\"4\\\",\\\"Numa\\\":\\\"2\\\",\\\"CoreCount\\\":\\\"2\\\"},\\\"StartTime\\\":\\\"2017-12-10T04:04Z\\\",\\\"Cpu\\\":\\\"8\\\",\\\"OSName\\\":\\\"CentOS 7.4 64 bit\\\",\\\"DeletionProtection\\\":\\\"false\\\",\\\"SecurityGroupIds\\\":{\\\"SecurityGroupId\\\":[null]},\\\"InstanceNetworkType\\\":\\\"vpc\\\",\\\"InnerIpAddress\\\":{\\\"IpAddress\\\":[\\\"42.112.**.**\\\"]},\\\"ExpiredTime\\\":\\\"2017-12-10T04:04Z\\\",\\\"EipAddress\\\":{\\\"AllocationId\\\":\\\"eip-2ze88m67qx5z****\\\",\\\"Bandwidth\\\":\\\"5\\\",\\\"IpAddress\\\":\\\"42.112.**.**\\\",\\\"IsSupportUnassociate\\\":\\\"true\\\",\\\"InternetChargeType\\\":\\\"PayByTraffic\\\"},\\\"ImageId\\\":\\\"m-bp67acfmxazb4p****\\\",\\\"ImageOptions\\\":{\\\"LoginAsNonRoot\\\":\\\"false\\\"},\\\"HostName\\\":\\\"testHostName\\\",\\\"Tags\\\":{\\\"Tag\\\":[null]},\\\"VlanId\\\":\\\"10\\\"}",
    "ResourceId": "i-bp1aaegapahkh880****",
    "ResourceName": "my-ecs",
    "ResourceStatus": "Running",
    "ResourceDeleted": "1",
    "ResourceCreationTime": "1646362560000",
    "Region": "cn-shanghai",
    "Version": "5",
    "AvailabilityZone": "cn-shanghai-g",
    "AccountId": "101339776561****",
    "Tags": "{\\\"key\\\":\\\"value\\\"}"
  }
}

错误码

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

变更历史

更多信息,参考变更详情