This operation returns the properties associated with an instance.
Request
Syntax
Send the request using either the ID or the name:
ID
GET <webservice>/instance/{instanceId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>Name
GET <webservice>/instance/byName(clientName='{clientName}',appName='{AppName}'),instanceName='{InstanceName}') HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>
where <webservice> is the root path used to route the API requests to the Web Server.
For more information, see Available Web Services for REST API.
Request Parameters
Name | Description | Required |
|---|---|---|
instanceId | The instance ID for the instance. If the instance ID is not known, use the GET Instance API to retrieve it. | Yes-for the request by ID |
clientName | The client name for the client. If the client name is not known, use the GET Client API to retrieve it. | Yes-for the request by name |
appName | The application name for the agent. If the application name is not known, use the GET Instance API to retrieve it. | Yes-for the request by name |
instanceName | The instance name for the instance. If the instance name is not known, use the GET Instance API to retrieve it. | Yes-for the request by name |
Request Headers
Name | Description |
|---|---|
Host | The host name of the Web Server or Web Console used in the API request. |
Accept | The format of the response. Valid values are: application/xml or application/json. |
Authtoken | The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication. |
Response
Response Parameters
Parameter | Description | Element | |||
|---|---|---|---|---|---|
instanceId | The system-generated ID assigned to the instance. | instance | |||
instanceName | The name of the instance. | instance | |||
appName | The name of the application. Valid values for the applicationId and appName parameters:
| instance | |||
applicationId | The ID of the application. For a list of application IDs, see the valid values for the appName parameter. | instance | |||
clientId | The system-generated ID assigned to the client. | instance | |||
clientName | The name of the client. | instance | |||
activityType | The instance activity control settings. Valid values are:
| activityControlOptions | |||
enableActivityType | The option to enable or disable an activity for an instance. JSON valid values are:
| activityControlOptions | |||
enableAfterADelay | The option to enable an activity for an instance on a date and time defined in the Enable Backup dialog box. JSON valid values are:
| activityControlOptions |
Examples
Sample Request
GET <webservice>/instance/byName(clientName='client001',appName='Windows File System'),instanceName='DefaultInstanceName') HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8Sample Response
XML
<?xml version='1.0' encoding='utf-8' ?>
<App_GetInstancePropertiesResponse>
<instanceProperties>
<instance instanceId="1" instanceName="DefaultInstanceName" applicationId="33" appName="Windows File System" clientId="2" clientName="client001"/>
<instanceActivityControl>
<activityControlOptions activityType="1" enableActivityType="1" enableAfterADelay="0"/>
</instanceActivityControl>
</instanceProperties>
</App_GetInstancePropertiesResponse>JSON
{
"instanceProperties": [{
"instance": {
"clientId": 2,
"clientName": "client001",
"instanceName": "DefaultInstanceName",
"appName": "Windows File System",
"instanceId": 1,
"applicationId": 33
},
"instanceActivityControl": {
"activityControlOptions": [{
"activityType": 2,
"enableAfterADelay": false,
"enableActivityType": true
}, {
"activityType": 1,
"enableAfterADelay": false,
"enableActivityType": true
}]
}
}]
}