华为云计算 云知识 查询资源实例ShowResInstanceInfo
查询资源实例ShowResInstanceInfo

 

功能介绍

查询资源实例。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/{project_id}/{resource_type}/resource-instances/{action}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目 ID,获取方式请参见获取项目ID

resource_type

String

资源类型

action

String

过滤/计数

枚举值:

  • filter

  • count

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

Boolean

是否通过标签过滤

limit

String

每页显示条数

offset

String

查询偏移量

action

String

查询指定action

枚举值:

  • count

  • filter

matches

Array of KvItem objects

查询指定键值对

sys_tags

Array of TagItem objects

查询指定系统标签列表

表4 KvItem

参数

是否必选

参数类型

描述

key

String

value

String

表5 TagItem

参数

是否必选

参数类型

描述

key

String

values

Array of strings

响应参数

状态码: 200

表6 响应Body参数

参数

参数类型

描述

resources

Array of ListEnterpriseResourceResult objects

企业项目列表

total_count

Long

资源数

表7 ListEnterpriseResourceResult

参数

参数类型

描述

resource_id

String

资源ID

resource_detail

ListFunctionResult object

函数属性结构体。

tags

Array of KvItem objects

标签列表

sys_tags

Array of KvItem objects

系统标签列表

resource_name

String

资源名称

表8 ListFunctionResult

参数

参数类型

描述

func_urn

String

函数的URN(Uniform Resource Name),唯一标识函数。

func_name

String

函数名称。

domain_id

String

域名id。

namespace

String

租户的project id。

project_name

String

租户的project name。

package

String

函数所属的分组Package,用于用户针对函数的自定义分组。

runtime

String

FunctionGraph函数的执行环境 Python2.7: Python语言2.7版本。 Python3.6: Pyton语言3.6版本。 Python3.9: Python语言3.9版本。 Go1.8: Go语言1.8版本。 Go1.x: Go语言1.x版本。 Java8: Java语言8版本。 Java11: Java语言11版本。 Node.js6.10: Nodejs语言6.10版本。 Node.js8.10: Nodejs语言8.10版本。 Node.js10.16: Nodejs语言10.16版本。 Node.js12.13: Nodejs语言12.13版本。 Node.js14.18: Nodejs语言14.18版本。 C#(.NET Core 2.0): C#语言2.0版本。 C#(.NET Core 2.1): C#语言2.1版本。 C#(.NET Core 3.1): C#语言3.1版本。 Custom: 自定义运行时。 PHP7.3: Php语言7.3版本。 http: HTTP函数。

枚举值:

  • Java8

  • Java11

  • Node.js6.10

  • Node.js8.10

  • Node.js10.16

  • Node.js12.13

  • Node.js14.18

  • Python2.7

  • Python3.6

  • Go1.8

  • Go1.x

  • C#(.NET Core 2.0)

  • C#(.NET Core 2.1)

  • C#(.NET Core 3.1)

  • Custom

  • PHP7.3

  • Python3.9

  • http

timeout

Integer

函数执行超时时间,超时函数将被强行停止,范围3~900秒,可以通过白名单配置延长到12小时,具体可以咨询华为云 函数工作流 服务进行配置

handler

String

函数执行入口 规则:xx.xx,必须包含“. ” 举例:对于node.js函数:myfunction.handler,则表示函数的文件名为myfunction.js,执行的入口函数名为handler。

memory_size

Integer

函数消耗的内存。 单位M。 取值范围为:128、256、512、768、1024、1280、1536、1792、2048、2560、3072、3584、4096。 最小值为128,最大值为4096。

gpu_memory

Integer

函数消耗的显存,只支持自定义运行时与 自定义镜像 函数配置GPU。 单位MB。 取值范围为:1024、2048、3072、4096、5120、6144、7168、8192、9216、10240、11264、12288、13312、14336、15360、16384。 最小值为1024,最大值为16384。

cpu

Integer

函数占用的cpu资源。 单位为millicore(1 core=1000 millicores)。 取值与MemorySize成比例,默认是128M内存占0.1个核(100 millicores)。 函数占用的CPU为基础CPU:200 millicores,再加上内存按比例占用的CPU,计算方法:内存/128 *100 + 200。

code_type

String

函数代码类型,取值有4种。 inline: UI在线编辑代码。 zip: 函数代码为zip包。 obs: 函数代码来源于obs存储。 jar: 函数代码为jar包,主要针对Java函数。

枚举值:

  • inline

  • zip

  • obs

  • jar

code_url

String

当CodeType为obs时,该值为函数代码包在OBS上的地址,CodeType为其他值时,该字段为空。

code_filename

String

函数的文件名,当CodeType为jar/zip时必须提供该字段,inline和obs不需要提供。

code_size

Long

函数大小,单位:字节。

user_data

String

用户自定义的name/value信息。 在函数中使用的参数。 举例:如函数要访问某个主机,可以设置自定义参数:Host={host_ip},最多定义20个,总长度不超过4KB。

encrypted_user_data

String

用户自定义的name/value信息,用于需要加密的配置。

digest

String

函数代码SHA512 hash值,用于判断函数是否变化。

version

String

函数版本号,由系统自动生成,规则:vYYYYMMDD-HHMMSS(v+年月日-时分秒)。

image_name

String

函数版本的内部标识。

xrole

String

函数使用的权限委托名称,需要IAM支持,并在IAM界面创建委托,当函数需要访问其他服务时,必须提供该字段。

app_xrole

String

函数app使用的权限委托名称,需要IAM支持,并在IAM界面创建委托,当函数需要访问其他服务时,必须提供该字段。

description

String

函数描述。

last_modified

String

函数最后一次更新时间。

func_vpc_id

String

用户的vpcid。

strategy_config

StrategyConfig object

函数策略配置。

extend_config

String

函数扩展配置。

initializer_handler

String

函数初始化入口,规则:xx.xx,必须包含“. ”。 举例:对于node.js函数:myfunction.initializer,则表示函数的文件名为myfunction.js,初始化的入口函数名为initializer。

initializer_timeout

Integer

初始化超时时间,超时函数将被强行停止,范围1~300秒。

enterprise_project_id

String

企业项目ID,在企业用户创建函数时必填。

long_time

Boolean

是否允许进行长时间超时设置。

log_group_id

String

自定义日志查询组id

log_stream_id

String

自定义日志查询流id

type

String

v2表示为公测版本,v1为原来版本。

枚举值:

  • v1

  • v2

fail_count

Integer

函数最近1天内执行失败的次数。

is_bridge_function

Boolean

是否为bridge函数

bind_bridge_funcUrns

Array of strings

绑定bridge函数的urn列表

表9 StrategyConfig

参数

参数类型

描述

concurrency

Integer

单函数最大实例数,v1取值0和-1,v2取值-1到1000 -1代表该函数实例数无限制 0代表该函数被禁用

concurrent_num

Integer

单实例最大并发数,v2版本才支持,取值-1到1000

表10 KvItem

参数

参数类型

描述

key

String

value

String

状态码: 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 401

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 403

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 404

表14 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码: 500

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询资源实例。

POST https://{Endpoint}/v2/{project_id}/{resource_type}/resource-instances/{action}

{
  "without_any_tag" : true,
  "limit" : 5,
  "matches" : [ {
    "key" : "resource_name",
    "value" : "test_function"
  } ]
}

响应示例

状态码: 200

ok

  • 示例 1

    {
      "resources" : [ {
        "resource_id" : "34e4516e-e324-412b-914e-c4e568c7d813",
        "resource_detail" : {
          "func_urn" : "",
          "func_name" : "test_v2_1",
          "domain_id" : "f0a16ead2b344414a5ff053409c4xxxx",
          "namespace" : "e3e37049e339493d996313d658f7xxxx",
          "project_name" : "{region}",
          "package" : "default",
          "runtime" : "Node.js6.10",
          "timeout" : 3,
          "handler" : "index.handler",
          "memory_size" : 128,
          "cpu" : 300,
          "code_type" : "inline",
          "code_filename" : "index.zip",
          "code_size" : "247",
          "digest" : "",
          "version" : "latest",
          "image_name" : "latest-191211192124@po1lk",
          "strategy_config" : { }
        },
        "tags" : [ ],
        "sys_tags" : [ {
          "key" : "_sys_enterprise_project_id",
          "value" : "df5edab8-c458-4a4c-b87b-a4d3b0a757ce"
        } ],
        "resource_name" : "test_v2_1"
      } ]
    }
  • 示例 2

    1

状态码

状态码

描述

200

ok

400

Bad Request 请求错误。

401

Unauthorized 鉴权失败。

403

Forbidden 没有操作权限。

404

Not Found 找不到资源。

500

Internal Server Error 服务内部错误。

错误码

请参见错误码

 

上一篇: 【物联网行业应用与解决方案】之智慧城市解决方案 下一篇:查询弹性云服务器详情列表ListServersDetails

弹性云服务器 ECS

 

弹性云服务器(Elastic Cloud Server)是一种可随时自助获取、可弹性伸缩的云服务器,帮助用户打造可靠、安全、灵活、高效的应用环境,确保服务持久稳定运行,提升运维效率