全部产品
Search
文档中心

云服务器 ECS:DescribeUserData - 查询一台ECS实例的自定义数据

更新时间:Mar 19, 2024

调用DescribeUserData查询一台ECS实例的自定义数据。

接口说明

  • 返回的实例自定义数据将以 Base64 编码的方式显示。
  • 如果实例不存在自定义数据,则返回空值。

调试

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

授权信息

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

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

请求参数

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

实例所属的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。

cn-hangzhou
InstanceIdstring

要查询的实例 ID。

i-bp14bnftyqhxg9ij****

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
InstanceIdstring

实例 ID。

i-bp14bnftyqhxg9ij****
UserDatastring

实例的自定义数据。

ZWNobyBoZWxsbyBlY321ABC
RegionIdstring

地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "InstanceId": "i-bp14bnftyqhxg9ij****",
  "UserData": "ZWNobyBoZWxsbyBlY321ABC",
  "RegionId": "cn-hangzhou"
}

错误码

HTTP status code错误码错误信息描述
404InvalidInstanceId.NotFoundThe specified InstanceId does not exist.指定的实例ID未找到。

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