Help Center/ DataArts Studio/ FAQs/ DataArts DataService/ How Can I Access APIs of DataArts DataService Exclusive Using Domain Names?
Updated on 2024-08-30 GMT+08:00
View PDF
Share

How Can I Access APIs of DataArts DataService Exclusive Using Domain Names?

The APIs can be accessed using domain names which are bound to the DataArts DataService Exclusive cluster.

  • Binding a private domain name: A private domain name takes effect in a VPC. When a private domain name is bound, it is associated with a private IP address. Then you can call APIs using the private domain name in the same VPC in the private network.

    On the Clusters page, locate a cluster, click More in the Operation column, select Bind Private Zone, and enter a custom private domain name. DataArts DataService invokes the DNS service to associate the private domain name with the private IP address. Each tenant can add up to 50 private domain names in all projects.

    The private domain name supports various domain name levels and must comply with domain name naming rules.
    • Domain name labels are separated by dot (.), and each label does not exceed 63 characters.
    • A domain name label can contain letters, digits, and hyphens (-) and cannot start or end with a hyphen.
    • The total length of the domain name cannot exceed 254 characters.
  • Binding a public domain name: A public domain name is resolved on the Internet. When a public domain name is bound, it is associated with a public IP address. Then you can call APIs using the public domain name on the Internet. On the Clusters page, locate a cluster, click More in the Operation column, select Bind Public Zone, and enter a registered domain name. DataArts DataService invokes the DNS service to associate the public domain name with the public IP address. To bind a public domain name, ensure that Public Address has been enabled during cluster creation and an EIP has been bound to the cluster. Otherwise, the public domain name cannot be bound to the cluster. In addition, each tenant can have up to 50 public domain names.

    The public domain name can include a primary domain name and its subdomain name, for example, abc.example.com.

In addition, if you already have an APIG dedicated instance or ROMA Connect instance, you can publish APIs to the APIG dedicated instance or ROMA Connect instance to provide a domain name access stream.
  • APIG Exclusive: To publish an API to APIG Exclusive, you must buy an APIG instance on the APIG console in advance. After the instance is created, a default API group is available. The system automatically assigns a debugging domain name for internal tests to the API group. This debugging domain name is unique and cannot be changed, and it can be accessed for a maximum of 1,000 times each day. If you want to create an API group exclusively for DataArts DataService APIs, see Creating an API Group. In addition, you can bind one or more independent domain names to an API group. For details, see Binding a Domain Name. The domain names can be used to call APIs for more than 1,000 times each day.
  • ROMA Connect instance: To publish an API to a ROMA Connect instance, you must create a ROMA Connect instance and an API group on the ROMA Connect console in advance. For details, see Creating an API Group. The system automatically allocates a subdomain name to the API group for internal testing. The subdomain name can be accessed for a maximum of 1,000 times each day. You can also bind independent domain names to the API group so that they can be used to call your published APIs. For details, see Binding Domain Names.
Parent topic: DataArts DataService