跳转到主要内容
ZStack
设置/资源高级设置相关接口

获取资源的资源高级设置

获取资源的资源高级设置

GET/zstack/v1/resource-configurations/{resourceUuid}/{category}/{name}

操作 ID

GetResourceConfig

起始版本

3.4.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

路径参数

  • category
    String必填

    设置类型

  • name
    String必填

    设置名称

  • resourceUuid
    String必填

    资源UUID

查询参数

  • systemTags
    List

    系统标签。

  • userTags
    List

    用户标签。

响应状态

200 OK
200 OK

该 API 成功时返回以下响应结构。

  • value
    String必填

    配置的值

  • success
    boolean必填

    操作是否成功。

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • effectiveConfigs
    List必填

    生效的设置列表，按优先级从高到低排序，详情参考effectiveConfigs

    • uuid
      String必填

      资源的UUID，唯一标示该资源

    • resourceUuid
      String必填

      配置对应的资源UUID

    • resourceType
      String必填

      配置对应的资源类型

    • name
      String必填

      配置名称

    • description
      String必填

      配置的详细描述

    • category
      String必填

      配置类别

    • value
      String必填

      配置的值

    • createDate
      Timestamp必填

      创建时间

    • lastOpDate
      Timestamp必填

      最后一次修改时间

  • error
    ErrorCode必填

    详情参考error

    • code
      String必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • description
      String必填

      错误的概要描述

    • details
      String必填

      错误的详细信息

    • elaboration
      String必填

      保留字段，默认为null

    • opaque
      LinkedHashMap必填

      保留字段，默认为null

    • cause
      ErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null