Help Center/ ServiceStage/ API Reference/ Application Management V3 APIs/ System Configuration/ Directory Settings/ Querying Directory Settings Based on the Directory Setting ID
Updated on 2025-11-28 GMT+08:00

Querying Directory Settings Based on the Directory Setting ID

Function

This API is used to query directory settings based on the directory setting ID.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:vmappConfig:get

    read

    -

    -

    -

    -

URI

GET /v3/{project_id}/cas/vmapp-configs/{vmapp_config_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Tenant's project ID. See Obtaining a Project ID.

vmapp_config_id

Yes

String

Directory setting ID. See Querying Directory Settings.

Request

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Message body type (format). Default value: application/json;charset=utf8.

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication.

Response

Table 3 Response parameters

Parameter

Type

Description

id

String

Directory setting ID.

name

String

Directory setting name.

project_id

String

Tenant's project ID.

run_as_user

String

Running user.

app_home

Object

Deployment directory settings. See Table 4.

log_home

Object

Log directory settings. See Table 4.

creator

String

Creator.

create_time

Integer

Creation time.

update_time

Integer

Update time.

Table 4 log_config

Parameter

Type

Description

path

String

Log path.

user

String

User to which the log path belongs.

group

String

User group to which the log path belongs.

mode

String

Log path permission.

Example Request

None

Example Response

{
    "id": "07bdd754-b5ae-4ccd-ba69-8c728a72b42d",
    "name": null,
    "project_id": "063a3158b1a34710b36ad208b9497d00",
    "run_as_user": "appuser",
    "app_home": {
        "path": "/home/appuser",
        "user": "appuser",
        "group": "appuser",
        "mode": "751"
    },
    "log_home": {
        "path": "/home/appuser/log",
        "user": "appuser",
        "group": "appuser",
        "mode": "751"
    },
    "creator": "paas_servicestage_test",
    "create_time": 1748920748270,
    "update_time": 1748920748270
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

409

Conflict

500

Internal Server Error

Error Code

See ServiceStage Error Codes.