Updated on 2026-04-10 GMT+08:00

Querying Directory Settings

Function

This API is used to query directory settings.

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:list

list

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
servicestage:vmappConfig:list	list	-	-	-	-

URI

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

**Table 1** Path parameter
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Tenant's project ID. See Obtaining a Project ID. Constraints N/A Range N/A Default Value N/A

Request

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
Content-Type	Yes	String	Definition Message body type (or format). Constraints N/A Range application/json;charset=utf8 Default Value N/A
X-Auth-Token	Yes	String	Definition 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. Constraints N/A Range N/A Default Value N/A

Response

**Table 3** Response parameters
Parameter	Type	Description
vmapp_configs	Array of objects	Definition Directory settings. See Table 4.
total	Integer	Definition Total number of directory settings. Range N/A

**Table 4** vmapp_config
Parameter	Type	Description
run_as_user	String	Definition Running user. Range N/A
app_home	Object	Definition Deployment directory settings. See Table 5.
log_home	Object	Definition Log directory settings. See Table 5.

**Table 5** log_config
Parameter	Type	Description
path	String	Definition Log path. Range N/A
user	String	Definition User to which the log path belongs. Range N/A
group	String	Definition User group to which the log path belongs. Range N/A
mode	String	Definition Log path permission. Range N/A

Example Request

None

Example Response

{
    "vmapp_configs": [
        {
            "run_as_user": "www",
            "app_home": {
                "path": "/opt/application",
                "user": "www",
                "group": "www",
                "mode": "751"
            },
            "log_home": {
                "path": "/var/log/application",
                "user": "www",
                "group": "www",
                "mode": "751"
            }
        },
        {
            "run_as_user": "www",
            "app_home": {
                "path": "/opt/application",
                "user": "www",
                "group": "www",
                "mode": "751"
            },
            "log_home": {
                "path": "/var/log/application",
                "user": "www",
                "group": "www",
                "mode": "751"
            }
        }
    ],
    "total": 2
}

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.

Parent topic: Directory Settings