Skip to main content
API Explorer|API Explorer
Resource Center/Network Resource/L3 Network Operations
GETL3 Network OperationsSince 0.6SynchronousAuth Required

GetL3NetworkDhcpIpAddress

GetL3NetworkDhcpIpAddress

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Query Parameters

Request Inputs

Path Parameters

  • l3NetworkUuidStringRequired

    The L3 network UUID.

Query Parameters

  • systemTagsList

    Optional. The system tags.

  • userTagsList

    Optional. The user tags.

Responses

200 OK

On success, this API returns the following response structure.

  • ipStringRequired

    The IP address.

  • ip6StringRequired

    The IPv6 address.

  • successbooleanRequired

    Whether the API succeeds.

  • errorErrorCodeRequired

    The error code. If not null, the operation fails, or vice versa. For more information, see error.

  • codeStringRequired

    The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.

  • descriptionStringRequired

    The brief description of the error.

  • detailsStringRequired

    The details about the error.

  • elaborationStringRequired

    The reserved field. Default value: null.

  • opaqueLinkedHashMapRequired

    The reserved field. Default value: null.

  • causeErrorCodeRequired

    The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.

Endpoint

GET/zstack/v1/l3-networks/{l3NetworkUuid}/dhcp-ip

/zstack/v1/l3-networks/{l3NetworkUuid}/dhcp-ip

Operation ID

GetL3NetworkDhcpIpAddress

Permalink

Request Example

curl -X GET 'http://{host}/zstack/v1/l3-networks/{l3NetworkUuid}/dhcp-ip?systemTags=<systemTags>&userTags=<userTags>' -H 'Authorization: OAuth {sessionUuid}'

Response Example

200
{ "ip": "192.168.100.3" }

Change History

This API has no change history records yet.

View all change history