Querying the Tor Information of an Instance
Function
This API is used to obtain the Top-of-Rack (Tor) switch information of a specified instance. It is used when you need to know the Tor switch connected to an instance for network configuration. Before using this API, ensure that you have logged in to the system and have the permission to query the Tor information of an instance, and the specified instance exists. After the query, the API returns the Tor information of the specified instance. If you do not have the operation permission, the specified instance does not exist, or the instance is not connected to the Tor switch, the API returns an error message.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v1/{project_id}/dev-servers/instance-physical-topologies
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
id |
No |
String |
Definition: Lite Server instance ID. Constraints: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Range: N/A Default Value: N/A |
|
resource_id |
No |
String |
Definition: Resource ID of the Lite Server instance. Constraints: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ Range: N/A Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
servers |
Array of ServerPhyInfo objects |
Definition: Server list. |
Example Requests
GET https://{endpoint}/v1/{project_id}/dev-servers/instance-physical-topologies?id=3efd3a22-41da-41c3-970d-5b670909acd1
Example Responses
Status code: 200
Definition: Response body for querying the Tor information of an instance
{
"servers" : [ {
"resource_id" : "3efd3a22-41da-41c3-970d-5b670909acd1",
"network_nodes" : [ "11.172.213.11", "11.172.213.12" ]
} ]
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Definition: Response body for querying the Tor information of an instance |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot