Querying the List of Origin IP Addresses
Function
This API is used to query the list of origin IP addresses.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
- If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.
URI
GET /v2/aad/source-ip
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| overseas_type | No | Integer | Protection region. 0: regions in the Chinese mainland. 1: regions outside the Chinese mainland. |
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 |
|---|---|---|
| ips | Array of SourceIp objects | ip |
| Parameter | Type | Description |
|---|---|---|
| data_center | String | Data center |
| isp | String | Line |
| ip | Array of strings | Back-to-origin IP address |
| ip_list | Array of SourceIpItem objects | Back-to-origin IP address list |
| Parameter | Type | Description |
|---|---|---|
| create_time | Long | Creation time. |
| ip | String | Back-to-origin IP address |
Status code: 400
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Error code. |
| error_description | String | Error description. |
Example Requests
GET https://{endpoint}/v2/aad/source-ip Example Responses
Status code: 200
{
"ips" : [ {
"isp" : "bgp",
"ip" : [ "103.xx.xx.0/24", "103.xx.19.0/24", "240e:xx:xx:01e1::/64", "240e:xx:xx:01e2::/64" ],
"data_center" : "hybgp",
"ip_list" : [ {
"ip" : "103.x.x.0/24",
"create_time" : 1639971694793
}, {
"ip" : "103.x.x.0/24",
"create_time" : 1639971694793
}, {
"ip" : "240e:xx:xx:01e1::/64",
"create_time" : 1660707607000
} ]
} ]
} 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 | 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.v2.region.AadRegion; import com.huaweicloud.sdk.aad.v2.*; import com.huaweicloud.sdk.aad.v2.model.*; public class ListSourceIpSolution { 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(); ListSourceIpRequest request = new ListSourceIpRequest(); try { ListSourceIpResponse response = client.listSourceIp(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 | # coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import GlobalCredentials from huaweicloudsdkaad.v2.region.aad_region import AadRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkaad.v2 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 = ListSourceIpRequest() response = client.list_source_ip(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 38 39 40 41 42 43 44 45 46 47 | package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/global" aad "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/aad/v2/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, err := global.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). SafeBuild() if err != nil { fmt.Println(err) return } hcClient, err := aad.AadClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). SafeBuild() if err != nil { fmt.Println(err) return } client := aad.NewAadClient(hcClient) request := &model.ListSourceIpRequest{} response, err := client.ListSourceIp(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 |
| 400 | Error response |
Error Codes
See Error Codes.
What is your overall rating for this page?
Thank 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