GroupDnGetAvailableListRequest

Bases: OCIRequest

Get the list of DNs that are assigned to a group and still available for assignment to users or service instances within the group. Dns assigned to the IMRN pool are not listed in the response. The response is either a GroupDnGetAvailableListResponse or an ErrorResponse.

Attributes:

service_provider_id (str):

group_id (str):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupDnGetAvailableListRequest(OCIRequest):
    """Get the list of DNs that are assigned to a group and still available for
        assignment to users or service instances within the group.
        Dns assigned to the IMRN pool are not listed in the response.
        The response is either a GroupDnGetAvailableListResponse or an ErrorResponse.

    Attributes:

        service_provider_id (str):

        group_id (str):

    """

    service_provider_id: str = field(metadata={"alias": "serviceProviderId"})

    group_id: str = field(metadata={"alias": "groupId"})

Responses

Bases: OCIDataResponse

Response to the GroupDnGetAvailableListRequest. The response contains the list of DNs that are assigned to a group and still available for assignment to users or service instances within the group.

Attributes:

phone_number (Optional[List[str]]):

Source code in src/mercury_ocip/commands/commands.py

@dataclass(kw_only=True)
class GroupDnGetAvailableListResponse(OCIDataResponse):
    """Response to the GroupDnGetAvailableListRequest.
        The response contains the list of DNs that are assigned to a group and still available for
        assignment to users or service instances within the group.

    Attributes:

        phone_number (Optional[List[str]]):

    """

    phone_number: Optional[List[str]] = field(
        default=None, metadata={"alias": "phoneNumber"}
    )

Bases: OCIResponse

Source code in src/mercury_ocip/commands/base_command.py

class ErrorResponse(OCIResponse):
    errorCode: Optional[int] = None
    summary: str
    summaryEnglish: str
    detail: Optional[str] = None

Example Usage

from mercury_ocip.client import Client
from mercury_ocip.commands import GroupDnGetAvailableListRequest

client = Client()

command = GroupDnGetAvailableListRequest(
    service_provider_id=...,
    group_id=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("GroupDnGetAvailableListRequest",
    service_provider_id=...,
    group_id=...,
)

print(response)