DescribeWebPath
Description
get the web directory definition information in the website backdoor settings.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeWebPath
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
Type | BODY | string | No | No sample value for this parameter. | configuration type, system-specified parameters. Value: web_path, indicating the configuration of the Web directory definition. |
PageSize | BODY | integer | No | No sample value for this parameter. | specifies the maximum number of records per page in the returned result. default value: 20 |
CurrentPage | BODY | integer | No | No sample value for this parameter. | specifies the number of pages currently returned. default value: 1 |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
TargetList | array | no demo value | the list of target hosts to which the web directory path is applied. see the following parameter description for specific sub-items. |
TotalCount | integer | no demo value | total number of records returned. |
Target | string | no demo value | host asset UUID. |
RequestId | string | no demo value | request ID. |
PageSize | integer | no demo value | page displays the maximum number of records. |
CurrentPage | integer | no demo value | currently returns page number. |
TargetType | string | no demo value | the fixed return value is uuid, indicating that the value of the Target parameter is the host asset UUID. |
Count | integer | no demo value | number of Web directory configuration records. |
WebPath | string | no demo value | Web directory path. |
ConfigList | array | no demo value | Web directory list, see the following parameter description for specific sub-items. |
Example
Successful Response example
{
"TargetList":"no demo value",
"TotalCount":"no demo value",
"Target":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"TargetType":"no demo value",
"Count":"no demo value",
"WebPath":"no demo value",
"ConfigList":"no demo value"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}