bosatsu
commented
3 months ago I want to enrich the issue above, because it seems like ZDK Rest API server is giving inconsistent results for GET operations against the v1/apps endpoint when using the Zscaler SDK.
Using the following env vars:
export ZSCALER_SDK_LOG=true
export ZSCALER_SDK_VERBOSE=trueIf I run the following code using the client NewRequestDo utility endpoint:
package main
import (
"log"
"net/http"
"os"
"github.com/zscaler/zscaler-sdk-go/v2/zdx"
"github.com/zscaler/zscaler-sdk-go/v2/zdx/services/common"
)
func main() {
// Init zscaler zdx config
apiKey := os.Getenv("ZDX_API_KEY_ID")
apiSecret := os.Getenv("ZDX_API_SECRET")
cfg, err := zdx.NewConfig(apiKey, apiSecret, "userAgent")
if err != nil {
log.Printf("[ERROR] creating client failed: %v\n", err)
return
}
cli := zdx.NewClient(cfg)
// Test pulling all apps using utility function
resp, err := cli.NewRequestDo(http.MethodGet, "v1/apps", common.GetFromToFilters{}, nil, nil)
if err != nil {
log.Printf("[ERROR] using NewRequestDo %v\n", err)
}
defer resp.Body.Close()
}I get the following zscaler log output:
zdx-logger: 2024/06/10 15:29:43 logger.go:36: [TRACE] Getting access token for ZDX_API_KEY_ID=(OMITTED)
zdx-logger: 2024/06/10 15:29:43 logger.go:36: [DEBUG] POST https://api.zdxcloud.net/v1/oauth/token
zdx-logger: 2024/06/10 15:29:44 logger.go:36: [DEBUG] Request "GET https://api.zdxcloud.net/v1/apps" details:
---[ ZSCALER SDK REQUEST | ID:a2770df1-c90b-44d3-be21-90d033e15913 ]-------------------------------
GET /v1/apps HTTP/1.1
Host: api.zdxcloud.net
User-Agent: userAgent
Authorization: Bearer (OMITTED)
Content-Type: application/json
Accept-Encoding: gzip
---------------------------------------------------------
zdx-logger: 2024/06/10 15:29:44 logger.go:36: [DEBUG] GET https://api.zdxcloud.net/v1/apps
zdx-logger: 2024/06/10 15:29:45 logger.go:36: [DEBUG] Response "GET https://api.zdxcloud.net/v1/apps" details:
---[ ZSCALER SDK RESPONSE | ID:a2770df1-c90b-44d3-be21-90d033e15913 | Duration:1.531663917s ]--------------------------------
HTTP/2.0 200 OK
Ccid: zscalertwo.net.51057371
Content-Type: application/json
Date: Mon, 10 Jun 2024 22:29:44 GMT
Ratelimit-Limit: 5
Ratelimit-Remaining: 4
Ratelimit-Reset: 1
Vary: Accept-Encoding, User-Agent
X-Api-Version: 2.1.0-2023-12-22T00:27:16Z
X-Ratelimit-Limit-Day: 10000
X-Ratelimit-Limit-Hour: 1000
X-Ratelimit-Limit-Minute: 30
X-Ratelimit-Limit-Second: 5
X-Ratelimit-Remaining-Day: 9702
X-Ratelimit-Remaining-Hour: 991
X-Ratelimit-Remaining-Minute: 28
X-Ratelimit-Remaining-Second: 4
(JSON RESPONSE OMITTED HERE, BUT WE RECEIVE THE EXPECTED JSON OUTPUT OF ALL APPLICATIONS DEFINED IN ZDX)
-------------------------------------------------------However if I run this code using the applications GetAllApps endpoint:
package main
import (
"log"
"os"
"github.com/zscaler/zscaler-sdk-go/v2/zdx"
"github.com/zscaler/zscaler-sdk-go/v2/zdx/services/reports/applications"
)
func main() {
// Init zscaler zdx config
apiKey := os.Getenv("ZDX_API_KEY_ID")
apiSecret := os.Getenv("ZDX_API_SECRET")
cfg, err := zdx.NewConfig(apiKey, apiSecret, "userAgent")
if err != nil {
log.Printf("[ERROR] creating client failed: %v\n", err)
return
}
cli := zdx.NewClient(cfg)
// Test getting all apps from "GetAllApps" endpoint
appClient := applications.New(cli)
_, _, err = appClient.GetAllApps(applications.GetAppsFilters{})
if err != nil {
log.Printf("SDK Endpoint Apps: [ERROR] using GetAllApps endpoint %v\n", err)
}
}It doesn't seem like the ZDX REST API is giving a response:
zdx-logger: 2024/06/10 15:43:32 logger.go:36: [TRACE] Getting access token for ZDX_API_KEY_ID=(OMITTED)
zdx-logger: 2024/06/10 15:43:32 logger.go:36: [DEBUG] POST https://api.zdxcloud.net/v1/oauth/token
zdx-logger: 2024/06/10 15:43:34 logger.go:36: [DEBUG] Request "GET https://api.zdxcloud.net/v1/apps" details:
---[ ZSCALER SDK REQUEST | ID:0894c565-126c-4973-ab99-09007b655a4f ]-------------------------------
GET /v1/apps HTTP/1.1
Host: api.zdxcloud.net
User-Agent: userAgent
Authorization: Bearer (OMITTED)
Content-Type: application/json
Accept-Encoding: gzip
---------------------------------------------------------It probably seems like I forgot something in the output above, but that is literally the only debug information that is printed to the terminal.
At this point if feels like I'm using the SDK wrong, but if I look at the SDK log information, I can't get past the lack of response returned. The GET request looks to be the same for both. What am I missing?
willguibr
Confirmation
zscaler-sdk-go version
v2.6.0
Go environment
Expected output
Object returned from
GetAllAppsendpoint is an*applications.Appsstruct, per the documentation. However I think this is likely incorrect and should be a slice ofapplications.Appsstructs, since this endpoint should retrieve all apps defined in ZDK. I'm new to using Go though, so I may be reading something incorrectly. However there is another issue that is happening before we get to this part of the code and I will describe this further down.Actual output
Object returned from
GetAllAppsendpoint isnilCatching and printing the error returned from
GetAllAppsreads:Code demonstrating the issue
Steps to reproduce
Run the code above.
References
No response