Skip to main content
ZStack
Settings/Settings Operations/Advanced Settings Operations

GetResourceConfig

GetResourceConfig

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

Operation ID

GetResourceConfig

Since

3.4.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Path Parameters

  • category
    StringRequired

    The setting category.

  • name
    StringRequired

    The setting name.

  • resourceUuid
    StringRequired

    The resource UUID.

Query Parameters

  • systemTags
    List

    Optional. The system tags.

  • userTags
    List

    Optional. The user tags.

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • value
    StringRequired

    The setting value.

  • success
    booleanRequired

    Whether the operation succeeded.

  • error
    ErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

  • effectiveConfigs
    ListRequired

    The setting list that takes effect. Settings are ordered from high to low priorities. For more information, see effectiveConfigs.

    • uuid
      StringRequired

      The resource UUID.

    • resourceUuid
      StringRequired

      The resource UUID corresponded by the setting.

    • resourceType
      StringRequired

      The resource type corresponded by the setting.

    • name
      StringRequired

      The setting name.

    • description
      StringRequired

      The detailed description of the setting.

    • category
      StringRequired

      The setting category.

    • value
      StringRequired

      The setting value.

    • createDate
      TimestampRequired

      The creation date.

    • lastOpDate
      TimestampRequired

      The last operation date.

  • error
    ErrorCodeRequired

    See error.

    • code
      StringRequired

      The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

    • description
      StringRequired

      The brief description of the error.

    • details
      StringRequired

      The details about the error.

    • elaboration
      StringRequired

      The reserved field. Default value: null.

    • opaque
      LinkedHashMapRequired

      The reserved field. Default value: null.

    • cause
      ErrorCodeRequired

      The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.