Querying the Forwarding Rules of an AAD IP Address
Function
This API is used to query the forwarding rules of AAD IP addresses.
Calling Method
For details, see Calling APIs.
URI
GET /v1/aad/instances/{instance_id}/{ip}/rules
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
instance_id |
Yes |
String |
Instance ID. |
|
ip |
Yes |
String |
Single IP address. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
limit |
No |
Integer |
Maximum records. |
|
offset |
No |
Integer |
Offset. |
Request Parameters
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
X-Auth-Token |
Yes |
String |
token |
|
Content-Type |
Yes |
String |
Content-Type |
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
total |
Integer |
Total forwarding rules. |
|
rules |
Array of TransferRuleInfo objects |
List of the forwarding rules. |
|
Parameter |
Type |
Description |
|---|---|---|
|
rule_id |
String |
Forwarding rule name ID. |
|
forward_protocol |
String |
Forwarding protocol. The value can be tcp or udp. |
|
forward_port |
Integer |
Forwarding port. |
|
source_port |
Integer |
Origin server port. |
|
lb_method |
String |
LVS forwarding rules. |
|
source_ip |
String |
Origin IP addresses. Use commas (,) to separate multiple IP addresses. A maximum of 20 IP addresses are allowed. |
|
status |
Integer |
Origin server status. 1: normal. 2: abnormal. |
Example Requests
None
Example Responses
Status code: 200
OK
{
"total" : 2,
"rules" : [ {
"rule_id" : "81c8XXXX-XXXX-XXXX-XXXX11c9",
"forward_protocol" : "tcp",
"forward_port" : 31,
"source_port" : 31,
"lb_method" : "rr",
"source_ip" : "4.0.1.1",
"status" : 1
}, {
"rule_id" : "ea86XXXX-XXXX-XXXX-XXXXfa13",
"forward_protocol" : "tcp",
"forward_port" : 61,
"source_port" : 61,
"lb_method" : "rr",
"source_ip" : "6.0.1.1",
"status" : 1
} ]
}
SDK Sample Code
The SDK sample code is as follows.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.GlobalCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.aad.v1.region.AadRegion; import com.huaweicloud.sdk.aad.v1.*; import com.huaweicloud.sdk.aad.v1.model.*; public class ListInstanceIpRuleSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new GlobalCredentials() .withAk(ak) .withSk(sk); AadClient client = AadClient.newBuilder() .withCredential(auth) .withRegion(AadRegion.valueOf("<YOUR REGION>")) .build(); ListInstanceIpRuleRequest request = new ListInstanceIpRuleRequest(); request.withInstanceId("{instance_id}"); request.withIp("{ip}"); try { ListInstanceIpRuleResponse response = client.listInstanceIpRule(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkaad.v1.region.aad_region import AadRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaad.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] credentials = GlobalCredentials(ak, sk) client = AadClient.new_builder() \ .with_credentials(credentials) \ .with_region(AadRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListInstanceIpRuleRequest() request.instance_id = "{instance_id}" request.ip = "{ip}" response = client.list_instance_ip_rule(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := aad.NewAadClient( aad.AadClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListInstanceIpRuleRequest{} request.InstanceId = "{instance_id}" request.Ip = "{ip}" response, err := client.ListInstanceIpRule(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK |
|
401 |
Unauthorized |
Error Codes
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