Skip to content

SystemDomainGetListRequest22V2

Bases: OCIRequest

Requests the list of all matching system-level domains and all matching reseller level domains. If excludeReseller is specified, returns all matching system-level domain names only. If resellerId is specified, returns all matching system-level domain names and the given reseller's domains. If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.

The response is either SystemDomainGetListResponse22V2 or ErrorResponse.

The following elements are only used in AS data mode and will be ingored in XS data mode:
  includeReseller
  resellerId
  responseSizeLimit
  searchCriteriaDomainName
  searchCriteriaResellerId
  searchCriteriaExactDomainLevel

Attributes:

exclude_reseller (Optional[bool]):

reseller_id (Optional[str]):

response_size_limit (Optional[int]):

search_criteria_domain_name (Optional[List[SearchCriteriaDomainName]]):

search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

search_criteria_exact_domain_level (Optional[SearchCriteriaExactDomainLevel]):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDomainGetListRequest22V2(OCIRequest):
    """Requests the list of all matching system-level domains and all matching reseller level domains.
        If excludeReseller is specified, returns all matching system-level domain names only.
        If resellerId is specified, returns all matching system-level domain names and the given reseller's domains.
        If reseller administrator sends the request and resellerId is not specified, the administrator's resellerId is used.

        The response is either SystemDomainGetListResponse22V2 or ErrorResponse.

        The following elements are only used in AS data mode and will be ingored in XS data mode:
          includeReseller
          resellerId
          responseSizeLimit
          searchCriteriaDomainName
          searchCriteriaResellerId
          searchCriteriaExactDomainLevel

    Attributes:

        exclude_reseller (Optional[bool]):

        reseller_id (Optional[str]):

        response_size_limit (Optional[int]):

        search_criteria_domain_name (Optional[List[SearchCriteriaDomainName]]):

        search_criteria_reseller_id (Optional[List[SearchCriteriaResellerId]]):

        search_criteria_exact_domain_level (Optional[SearchCriteriaExactDomainLevel]):

    """

    exclude_reseller: Optional[bool] = field(
        default=None, metadata={"alias": "excludeReseller"}
    )

    reseller_id: Optional[str] = field(default=None, metadata={"alias": "resellerId"})

    response_size_limit: Optional[int] = field(
        default=None, metadata={"alias": "responseSizeLimit"}
    )

    search_criteria_domain_name: Optional[List[SearchCriteriaDomainName]] = field(
        default=None, metadata={"alias": "searchCriteriaDomainName"}
    )

    search_criteria_reseller_id: Optional[List[SearchCriteriaResellerId]] = field(
        default=None, metadata={"alias": "searchCriteriaResellerId"}
    )

    search_criteria_exact_domain_level: Optional[SearchCriteriaExactDomainLevel] = (
        field(default=None, metadata={"alias": "searchCriteriaExactDomainLevel"})
    )

Responses

Bases: OCIDataResponse

Contains a table of all matching system-level domain names and all matching reseller level domains. The column headings are: "Domain Name" and "Reseller Id".

Attributes:

system_default_domain (Optional[str]):

domain_table (OCITable):
Source code in src/mercury_ocip/commands/commands.py
@dataclass(kw_only=True)
class SystemDomainGetListResponse22V2(OCIDataResponse):
    """Contains a table of all matching system-level domain names and all matching reseller level domains.
        The column headings are: \"Domain Name\" and \"Reseller Id\".

    Attributes:

        system_default_domain (Optional[str]):

        domain_table (OCITable):

    """

    system_default_domain: Optional[str] = field(
        default=None, metadata={"alias": "systemDefaultDomain"}
    )

    domain_table: OCITable = field(metadata={"alias": "domainTable"})

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 SystemDomainGetListRequest22V2

client = Client()

command = SystemDomainGetListRequest22V2(
    exclude_reseller=...,
    reseller_id=...,
    response_size_limit=...,
    search_criteria_domain_name=...,
    search_criteria_reseller_id=...,
    search_criteria_exact_domain_level=...,
)

response = client.command(command)

print(response)

Example 2 with Raw Command

from mercury_ocip.client import Client

client = Client()

response = client.raw_command("SystemDomainGetListRequest22V2",
    exclude_reseller=...,
    reseller_id=...,
    response_size_limit=...,
    search_criteria_domain_name=...,
    search_criteria_reseller_id=...,
    search_criteria_exact_domain_level=...,
)

print(response)