Viewing Details of a DDM Instance
Function
This API is used to query the details about a DDM instance.
Constraints
None
URI
GET /v1/{project_id}/instances/{instance_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID of a tenant in a region |
instance_id |
Yes |
String |
DDM instance ID |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
DDM instance ID |
status |
String |
DDM instance status |
name |
String |
Name of the DDM instance |
created |
String |
Time when the DDM instance is created |
updated |
String |
Time when the DDM instance is last updated |
available_zone |
String |
Name of the AZ where the DDM instance is located |
vpc_id |
String |
VPC ID |
subnet_id |
String |
Subnet ID |
security_group_id |
String |
Security group ID |
node_count |
Integer |
Number of nodes |
access_ip |
String |
Address for accessing the DDM instance |
access_port |
String |
Port for accessing the DDM instance |
node_status |
String |
Node status |
core_count |
String |
Number of CPUs |
ram_capacity |
String |
Memory size in GB |
error_msg |
String |
Response message. This parameter is not returned if no error occurs. |
project_id |
String |
Project ID |
order_id |
String |
Order ID |
enterprise_project_id |
String |
Enterprise project ID |
engine_version |
String |
Engine version (core version) |
nodes |
Array of GetDDMDetailfNodesInfo objects |
Node information |
Parameter |
Type |
Description |
---|---|---|
status |
String |
Status of the DDM instance node |
port |
String |
Port of the DDM instance node |
ip |
String |
IP address of the DDM instance node |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
errCode |
String |
Service error code |
externalMessage |
String |
Error message |
Example Request
GET https://{endpoint}/v1/{project_id}/instances/{instance_id}
Example Response
Status code: 400
bad request
{ "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" }
Status code: 500
server error
{ "externalMessage" : "Parameter error.", "errCode" : "DBS.280001" }
Status Codes
For details, see Status Codes.
Error Codes
For details, 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